GetGoodsOwnersByQuery
Returns all goods owners.
Tags: GetGoodsOwnersByQuery, GetGoodsOwnersByQueryResponse, GetGoodsOwnersResult, GetGoodsOwnersInfo, GoodsOwnerGroupInfo, GoodsOwnerActiveInvoice, GoodsOwnerReferenceInfo, GoodsOwnerAddress, GoodsOwnerWarehouse
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>
</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>
</GetGoodsOwnersInfo>
<GetGoodsOwnersInfo>
<GoodsOwnerId>int</GoodsOwnerId>
<GoodsOwnerName>string</GoodsOwnerName>
<GoodsOwnerComment>string</GoodsOwnerComment>
<IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
<GoodsOwnerGroup>
<Id>int</Id>
<Code>string</Code>
</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>
</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 Goodsowner |
GoodsOwnerName |
string(400) |
The name of the Goodsowner |
GoodsOwnerComment |
string(3000) |
Goodsowner comment |
IsTrainingGoodsOwner |
boolean |
Indicates if Goodsowner is used for training. |
GoodsOwnerGroup |
GoodsOwnerGroupInfo |
Used to group Goodsowners. GoodsOwnerGroup |
ActiveInvoice |
GoodsOwnerActiveInvoice |
Goodsowner current active invoice. GoodsOwnerActiveInvoice |
References |
GoodsOwnerReferenceInfo |
Goodsowners references. GoodsOwnerReferenceInfo |
Address |
GoodsOwnerAddress |
An element of type GoodsOwnerAddress. |
DefaultWarehouse |
GoodsOwnerWarehouse |
Goodsowners references. GoodsOwnerReferenceInfo |
GoodsOwnerGroupInfo |
Id |
int |
Internal id of goodsowner group |
Code |
string(50) |
Group code |
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) |
Goodsowner financial code. Used for invoicing. |
GoodsLocationCode |
string(50) |
Goods location code |
GoodsOwnerContactReference |
string(50) |
Goodsowner contact reference |
GoodsOwnerReference |
string(100) |
Goodsowner reference |
GoodsOwnerAdviseEmail |
string(300) |
Goodsowner 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 |