Ongoing Warehouse logo

Ongoing Warehouse Developer

GetGoodsOwnersByQuery

Returns all goods owners.

Tags: GetGoodsOwnersByQuery, GetGoodsOwnersByQueryResponse, GetGoodsOwnersByQueryResult, GetGoodsOwnersInfo, GoodsOwnerActiveInvoice, GoodsOwnerGroup, GoodsOwnerReferenceInfo

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 str(50) Req. Your username.
Password str(50) Req. Your password.
Query object Req. An empty tag

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
                        <ActiveInvoice>
                            <Id>int</Id>
                            <InvoicePeriodFrom>dateTime</InvoicePeriodFrom>
                            <InvoicePeriodTo>dateTime</InvoicePeriodTo>
                            <InvoiceNumber>string</InvoiceNumber>
                        </ActiveInvoice>
                        <GoodsOwnerGroup>
                            <Id>int</Id>
                            <Code>string</Code>
                        </GoodsOwnerGroup>
                        <References>
                            <FinancialCode>string</FinancialCode>
                            <GoodsLocationCode>string</GoodsLocationCode>
                            <GoodsOwnerContactReference>string</GoodsOwnerContactReference>
                            <GoodsOwnerReference>string</GoodsOwnerReference>
                            <GoodsOwnerAdviseEmail>string</GoodsOwnerAdviseEmail>
                        </References>
                    </GetGoodsOwnersInfo>
                    <GetGoodsOwnersInfo>
                        <GoodsOwnerId>int</GoodsOwnerId>
                        <GoodsOwnerName>string</GoodsOwnerName>
                        <GoodsOwnerComment>string</GoodsOwnerComment>
                        <IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
                        <ActiveInvoice>
                            <Id>int</Id>
                            <InvoicePeriodFrom>dateTime</InvoicePeriodFrom>
                            <InvoicePeriodTo>dateTime</InvoicePeriodTo>
                            <InvoiceNumber>string</InvoiceNumber>
                        </ActiveInvoice>
                        <GoodsOwnerGroup>
                            <Id>int</Id>
                            <Code>string</Code>
                        </GoodsOwnerGroup>
                        <References>
                            <FinancialCode>string</FinancialCode>
                            <GoodsLocationCode>string</GoodsLocationCode>
                            <GoodsOwnerContactReference>string</GoodsOwnerContactReference>
                            <GoodsOwnerReference>string</GoodsOwnerReference>
                            <GoodsOwnerAdviseEmail>string</GoodsOwnerAdviseEmail>
                        </References>
                    </GetGoodsOwnersInfo>
                </GoodsOwners>
            </GetGoodsOwnersByQueryResult>
        </GetGoodsOwnersByQueryResponse>
    </soap:Body>
</soap:Envelope>
+

Response specification

GetUsersResult
GetGoodsOwnersByQueryResult object A GetGoodsOwnersByQueryResult object
GetGoodsOwnersByQueryResult
Success bool True if the call succeeded, false otherwise
Message string If the call failed, this field contains the error message
GoodsOwners object A list of GetGoodsOwnersInfo
GetGoodsOwnersInfo
GoodsOwnerName str(400) The name of the Goodsowner
GoodsOwnerId int Internal id for the Goodsowner
IsTrainingGoodsOwner bool Indicates if Goodsowner is used for training.
GoodsOwnerComment str(3000) Goodsowner comment
ActiveInvoice object Goodsowner current active invoice. GoodsOwnerActiveInvoice
GoodsOwnerGroup object Used to group Goodsowners. GoodsOwnerGroup
References object Goodsowners references. GoodsOwnerReferenceInfo
GoodsOwnerActiveInvoice
Id int Internal id of active invoice
InvoiceNumber str(50) Invoice number
InvoicePeriodFrom dateTime Start of invoice period
InvoicePeriodTo dateTime End of invoice period
GoodsOwnerGroup
Id int Internal id of goodsowner group
Code str(50) Group code
GoodsOwnerReferenceInfo
FinancialCode str(50) Goodsowner financial code. Used for invoicing.
GoodsLocationCode str(50) Goods location code
GoodsOwnerContactReference str(50) Goodsowner contact reference
GoodsOwnerReference str(100) Goodsowner reference
GoodsOwnerAdviseEmail str(300) Goodsowner advise email. For instance for sending reports.