GET api/ClientLocationDeliveryDates
Gets the delivery dates of a client location
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientNumber |
The number of the client defined by the wholesaler |
string |
Max length: 50 |
| ShowOnlyDatesAsOf |
Show only delivery dates as of (includes the given date) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
URI Example
api/ClientLocationDeliveryDates?ClientNumber={ClientNumber}&ShowOnlyDatesAsOf={ShowOnlyDatesAsOf}
Body Parameters
None.
Response Information
Resource Description
A wrapper with client delivery date entity data
Oresto.API.Models.GET.ClientLocationDeliveryDates.ClientLocationDeliveryDateData| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientLocationDeliveryDates |
A list of client location delivery dates for one or multiple client / locations |
Collection of Oresto.API.Models.GET.ClientLocationDeliveryDates.ClientLocationDeliveryDate |
None. |
| Errors |
Possible errors that were experienced when processing the request |
Collection of string |
None. |
| RequestInformation |
Additional information about the request |
Oresto.API.Models.Shared.RequestInformation |
None. |
Response Formats
application/json, text/json
Sample:
{
"ClientLocationDeliveryDates": [
{
"ClientNumber": "sample string 1",
"ClientLocations": [
{
"Id": 1,
"Company": "sample string 2",
"DeliveryDates": [
{
"Date": "sample string 1"
},
{
"Date": "sample string 1"
}
]
},
{
"Id": 1,
"Company": "sample string 2",
"DeliveryDates": [
{
"Date": "sample string 1"
},
{
"Date": "sample string 1"
}
]
}
]
},
{
"ClientNumber": "sample string 1",
"ClientLocations": [
{
"Id": 1,
"Company": "sample string 2",
"DeliveryDates": [
{
"Date": "sample string 1"
},
{
"Date": "sample string 1"
}
]
},
{
"Id": 1,
"Company": "sample string 2",
"DeliveryDates": [
{
"Date": "sample string 1"
},
{
"Date": "sample string 1"
}
]
}
]
}
],
"RequestInformation": {
"RequestDuration": 1,
"WholesalerId": 2,
"UserId": 3
},
"Errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ClientLocationDeliveryDateData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.GET.ClientLocationDeliveryDates">
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<RequestDuration>1</RequestDuration>
<UserId>3</UserId>
<WholesalerId>2</WholesalerId>
</RequestInformation>
<ClientLocationDeliveryDates>
<ClientLocationDeliveryDate>
<ClientLocations>
<ClientLocation>
<Company>sample string 2</Company>
<DeliveryDates>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
</DeliveryDates>
<Id>1</Id>
</ClientLocation>
<ClientLocation>
<Company>sample string 2</Company>
<DeliveryDates>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
</DeliveryDates>
<Id>1</Id>
</ClientLocation>
</ClientLocations>
<ClientNumber>sample string 1</ClientNumber>
</ClientLocationDeliveryDate>
<ClientLocationDeliveryDate>
<ClientLocations>
<ClientLocation>
<Company>sample string 2</Company>
<DeliveryDates>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
</DeliveryDates>
<Id>1</Id>
</ClientLocation>
<ClientLocation>
<Company>sample string 2</Company>
<DeliveryDates>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
<DeliveryDate>
<Date>sample string 1</Date>
</DeliveryDate>
</DeliveryDates>
<Id>1</Id>
</ClientLocation>
</ClientLocations>
<ClientNumber>sample string 1</ClientNumber>
</ClientLocationDeliveryDate>
</ClientLocationDeliveryDates>
</ClientLocationDeliveryDateData>