GetGoodsOwnersByQuery

Returns all goods owners.

Tags: GetGoodsOwnersByQuery, GetGoodsOwnersByQueryResponse, GetGoodsOwnersResult, GetGoodsOwnersInfo, GoodsOwnerGroupInfo, GoodsOwnerActiveInvoice, GoodsOwnerReferenceInfo, GoodsOwnerAddress, GoodsOwnerWarehouse, GoodsOwnerClass, GoodsOwnerInvoicingCurrency

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetGoodsOwnersByQuery"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGoodsOwnersByQuery xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query />
    </GetGoodsOwnersByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

GetGoodsOwnersByQuery
UserName	string(50)	Req.	Your username
Password	string(50)	Req.	Your password
Query	GetGoodsOwnersQuery	Req.	An empty tag.

Response XML

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGoodsOwnersByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetGoodsOwnersByQueryResult>
        <Message>string</Message>
        <Success>boolean</Success>
        <GoodsOwners>
          <GetGoodsOwnersInfo>
            <GoodsOwnerId>int</GoodsOwnerId>
            <GoodsOwnerName>string</GoodsOwnerName>
            <GoodsOwnerComment>string</GoodsOwnerComment>
            <IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
            <GoodsOwnerGroup>
              <Id>int</Id>
              <Code>string</Code>
              <Name>string</Name>
            </GoodsOwnerGroup>
            <ActiveInvoice>
              <Id>int</Id>
              <InvoicePeriodFrom>dateTime</InvoicePeriodFrom>
              <InvoicePeriodTo>dateTime</InvoicePeriodTo>
              <InvoiceNumber>string</InvoiceNumber>
            </ActiveInvoice>
            <References>
              <FinancialCode>string</FinancialCode>
              <GoodsLocationCode>string</GoodsLocationCode>
              <GoodsOwnerContactReference>string</GoodsOwnerContactReference>
              <GoodsOwnerReference>string</GoodsOwnerReference>
              <GoodsOwnerAdviseEmail>string</GoodsOwnerAdviseEmail>
            </References>
            <Address>
              <Name>string</Name>
              <Address>string</Address>
              <Address2>string</Address2>
              <Address3>string</Address3>
              <PostCode>string</PostCode>
              <City>string</City>
              <TelePhone>string</TelePhone>
              <Email>string</Email>
              <MobilePhone>string</MobilePhone>
              <CountryStateCode>string</CountryStateCode>
              <CountryCode>string</CountryCode>
              <DeliveryInstruction>string</DeliveryInstruction>
              <NotifyBySMS>boolean</NotifyBySMS>
              <NotifyByEmail>boolean</NotifyByEmail>
              <NotifyByTelephone>boolean</NotifyByTelephone>
            </Address>
            <DefaultWarehouse>
              <WarehouseId>int</WarehouseId>
              <WarehouseName>string</WarehouseName>
              <WarehouseCode>string</WarehouseCode>
            </DefaultWarehouse>
            <GoodsOwnerClasses>
              <GoodsOwnerClass>
                <Id>int</Id>
                <Code>string</Code>
                <Name>string</Name>
              </GoodsOwnerClass>
              <GoodsOwnerClass>
                <Id>int</Id>
                <Code>string</Code>
                <Name>string</Name>
              </GoodsOwnerClass>
            </GoodsOwnerClasses>
            <GoodsOwnerInvoicingCurrency>
              <Code>string</Code>
              <Name>string</Name>
            </GoodsOwnerInvoicingCurrency>
          </GetGoodsOwnersInfo>
          <GetGoodsOwnersInfo>
            <GoodsOwnerId>int</GoodsOwnerId>
            <GoodsOwnerName>string</GoodsOwnerName>
            <GoodsOwnerComment>string</GoodsOwnerComment>
            <IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
            <GoodsOwnerGroup>
              <Id>int</Id>
              <Code>string</Code>
              <Name>string</Name>
            </GoodsOwnerGroup>
            <ActiveInvoice>
              <Id>int</Id>
              <InvoicePeriodFrom>dateTime</InvoicePeriodFrom>
              <InvoicePeriodTo>dateTime</InvoicePeriodTo>
              <InvoiceNumber>string</InvoiceNumber>
            </ActiveInvoice>
            <References>
              <FinancialCode>string</FinancialCode>
              <GoodsLocationCode>string</GoodsLocationCode>
              <GoodsOwnerContactReference>string</GoodsOwnerContactReference>
              <GoodsOwnerReference>string</GoodsOwnerReference>
              <GoodsOwnerAdviseEmail>string</GoodsOwnerAdviseEmail>
            </References>
            <Address>
              <Name>string</Name>
              <Address>string</Address>
              <Address2>string</Address2>
              <Address3>string</Address3>
              <PostCode>string</PostCode>
              <City>string</City>
              <TelePhone>string</TelePhone>
              <Email>string</Email>
              <MobilePhone>string</MobilePhone>
              <CountryStateCode>string</CountryStateCode>
              <CountryCode>string</CountryCode>
              <DeliveryInstruction>string</DeliveryInstruction>
              <NotifyBySMS>boolean</NotifyBySMS>
              <NotifyByEmail>boolean</NotifyByEmail>
              <NotifyByTelephone>boolean</NotifyByTelephone>
            </Address>
            <DefaultWarehouse>
              <WarehouseId>int</WarehouseId>
              <WarehouseName>string</WarehouseName>
              <WarehouseCode>string</WarehouseCode>
            </DefaultWarehouse>
            <GoodsOwnerClasses>
              <GoodsOwnerClass>
                <Id>int</Id>
                <Code>string</Code>
                <Name>string</Name>
              </GoodsOwnerClass>
              <GoodsOwnerClass>
                <Id>int</Id>
                <Code>string</Code>
                <Name>string</Name>
              </GoodsOwnerClass>
            </GoodsOwnerClasses>
            <GoodsOwnerInvoicingCurrency>
              <Code>string</Code>
              <Name>string</Name>
            </GoodsOwnerInvoicingCurrency>
          </GetGoodsOwnersInfo>
        </GoodsOwners>
      </GetGoodsOwnersByQueryResult>
    </GetGoodsOwnersByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetGoodsOwnersByQueryResponse
GetGoodsOwnersByQueryResult	GetGoodsOwnersResult

GetGoodsOwnersResult
Message	string	If the call failed, this field contains the error message
Success	boolean	True if the call succeeded, false otherwise
GoodsOwners	GetGoodsOwnersInfo[]	A list of GetGoodsOwnersInfo

GetGoodsOwnersInfo
GoodsOwnerId	int	Internal id for the goods owner
GoodsOwnerName	string(400)	The name of the goods owner
GoodsOwnerComment	string(3000)	Goods owner comment
IsTrainingGoodsOwner	boolean	Indicates if goods owner is used for training.
GoodsOwnerGroup	GoodsOwnerGroupInfo	Used to group goods owners. GoodsOwnerGroup
ActiveInvoice	GoodsOwnerActiveInvoice	Goods owner's current active invoice. GoodsOwnerActiveInvoice
References	GoodsOwnerReferenceInfo	Goods owner's references. GoodsOwnerReferenceInfo
Address	GoodsOwnerAddress	An element of type GoodsOwnerAddress.
DefaultWarehouse	GoodsOwnerWarehouse	Goods owner's default warehouse. GoodsOwnerWarehouse
GoodsOwnerClasses	GoodsOwnerClass[]	Goods owner classes. GoodsOwnerClass
GoodsOwnerInvoicingCurrency	GoodsOwnerInvoicingCurrency	Goods owner's default warehouse. GoodsOwnernvoicingCurrency

GoodsOwnerGroupInfo
Id	int	Internal id of goods owner group
Code	string(50)	Group code
Name	string(50)	Group name

GoodsOwnerActiveInvoice
Id	int	Internal id of active invoice
InvoicePeriodFrom	dateTime	Start of invoice period
InvoicePeriodTo	dateTime	End of invoice period
InvoiceNumber	string(50)	Invoice number

GoodsOwnerReferenceInfo
FinancialCode	string(50)	Good sowner financial code. Used for invoicing.
GoodsLocationCode	string(50)	Goods location code
GoodsOwnerContactReference	string(50)	Goods owner contact reference
GoodsOwnerReference	string(100)	Good sowner reference
GoodsOwnerAdviseEmail	string(300)	Goods owner advise email. For instance for sending reports.

GoodsOwnerAddress
Name	string
Address	string
Address2	string
Address3	string
PostCode	string
City	string
TelePhone	string
Email	string
MobilePhone	string
CountryStateCode	string
CountryCode	string
DeliveryInstruction	string
NotifyBySMS	boolean
NotifyByEmail	boolean
NotifyByTelephone	boolean

GoodsOwnerWarehouse
WarehouseId	int	Internal id for the warehouse
WarehouseName	string(200)	The name of the warehouse
WarehouseCode	string(50)	The code of the warehouse

GoodsOwnerClass
Id	int	Id of the goods owner class.
Code	string(100)	Code of the goods owner class.
Name	string(200)	Name of the goods owner class.

GoodsOwnerInvoicingCurrency
Code	string(100)	Code of the goods owner invoicing currency.
Name	string(200)	Name of the goods owner invoicing currency.