IBookingAuthenticateRestWcfServiceOrderListJson Method |
Uri for this REST service method:
https://appl.easybook.net/booking/json/{partnerCode}/{consumerId}/orderlist?dateFrom={dateFrom}&dateTo={dateTo}&state={state}&count={count}&offset={offset}&changedsince={changedsince}&includeWithoutCommission={includeWithoutCommission}
Http method: GET
Response body format: Json
Returns partner order info.
Namespace:
Tse.EasyBook.Server.WcfContracts.WebClient
Assembly:
Tse.EasyBook.Server.WcfContracts (in Tse.EasyBook.Server.WcfContracts.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxOrderListResult OrderListJson(
string partnerCode,
string consumerId,
string dateFrom,
string dateTo,
string state,
string count,
string offset,
string changedsince,
string includeWithoutCommission
)
Parameters
- partnerCode
- Type: SystemString
A path parameter containing the partner code a.k.a. the login. Example: /LHUSE - consumerId
- Type: SystemString
A path parameter always assigned the integer number 1.Example: /1 - dateFrom
- Type: SystemString
A date formatted as DD-MM-YYYY. Limit the result to orders where the arrival date larger than or equal to this date. - dateTo
- Type: SystemString
A date formatted as DD-MM-YYYY. Limit the result to orders where the arrival date smaller than or equal to this date. - state
- Type: SystemString
Order State or null if all states should be returned. For possible values OrderStateWebEnum - count
- Type: SystemString
The number of orders to return in a batch starting at the offset of the criteria parameter Offsetoffset. The default value is 10. Please use the criteria Offset and Count besides the result field TotalCountTotalResults to get orders in batches. - offset
- Type: SystemString
The offset of a batch of orders. The minimum value is 1 and it is also the default value. Please use the criteria Offset and Count besides the result field TotalResults to get orders in batches. - changedsince
- Type: SystemString
Either it is omitted or it is a time stamp formatted as DD-MM-YYYY HH-MM-SS. Examle: 13-04-2024 22:25:00. If it is filled out, it
limits the result to orders containing invoices where the created date is larger than or equal to the time stamp.
Hence only orders containing one or more invoice(s) created or credited after this timestamp are returned.
- includeWithoutCommission
- Type: SystemString
Also include invoices associated with partners where the invoices are without commission given to the partner.
Normally/default these invoices are excluded. Hence this is an optionally parameter.
Return Value
Type:
OrderListResult[Missing <returns> documentation for "M:Tse.EasyBook.Server.WcfContracts.WebClient.IBookingAuthenticateRestWcfService.OrderListJson(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)"]
See Also