DX STF Client API

<back to all web services

GetOrderByDateRange

Order Requests

Order

Requires Authentication
The following routes are available for this service:
GET/api/order/from/{FromDate}/to/{ToDate}Get invoice between start and end date

/** @description Order */
// @Api(Description="Order")
// @ApiResponse(Description="Paged invoice response between start and end date", IsDefaultResponse=true, StatusCode=200)
export class GetOrderByDateRange
{
    /** @description Requested page number, starting at 1 */
    // @ApiMember(Description="Requested page number, starting at 1")
    public requestedPage: number;

    /** @description Number of records to return on a page */
    // @ApiMember(Description="Number of records to return on a page")
    public numberOfRecordsPerPage: number;

    /** @description From Date Time */
    // @ApiMember(Description="From Date Time", ParameterType="path")
    public fromDate: string;

    /** @description To Date Time */
    // @ApiMember(Description="To Date Time", ParameterType="path")
    public toDate: string;

    public constructor(init?: Partial<GetOrderByDateRange>) { (Object as any).assign(this, init); }
}

export class PagedQueryResult<T>
{
    public startIndex: number;
    public endIndex: number;
    public numberOfRecordsReturned: number;
    public totalNumberOfPages: number;
    public totalNumberOfRecords: number;
    public results: ResultItem<ClaimMessage>[] = [];

    public constructor(init?: Partial<PagedQueryResult<T>>) { (Object as any).assign(this, init); }
}

TypeScript GetOrderByDateRange DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/order/from/{FromDate}/to/{ToDate} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	startIndex: 0,
	endIndex: 0,
	numberOfRecordsReturned: 0,
	totalNumberOfPages: 0,
	totalNumberOfRecords: 0,
	results: 
	[
		{
			
		}
	]
}