DX STF Client API

<back to all web services

GetOrderResponseByDateRange

Order Response Requests

Order Response

Requires Authentication
The following routes are available for this service:
GET/api/orderResponse/from/{FromDate}/to/{ToDate}Get Order Response between start and end date
"use strict";
export class GetOrderResponseByDateRange {
    /** @param {{requestedPage?:number,numberOfRecordsPerPage?:number,fromDate?:string,toDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Requested page number, starting at 1 */
    requestedPage;
    /**
     * @type {number}
     * @description Number of records to return on a page */
    numberOfRecordsPerPage;
    /**
     * @type {string}
     * @description From Date Time */
    fromDate;
    /**
     * @type {string}
     * @description To Date Time */
    toDate;
}
/** @typedef T {any} */
export class PagedQueryResult {
    /** @param {{startIndex?:number,endIndex?:number,numberOfRecordsReturned?:number,totalNumberOfPages?:number,totalNumberOfRecords?:number,results?:ResultItem<ClaimMessage>[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    startIndex;
    /** @type {number} */
    endIndex;
    /** @type {number} */
    numberOfRecordsReturned;
    /** @type {number} */
    totalNumberOfPages;
    /** @type {number} */
    totalNumberOfRecords;
    /** @type {ResultItem<ClaimMessage>[]} */
    results = [];
}

JavaScript GetOrderResponseByDateRange 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/orderResponse/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: 
	[
		{
			
		}
	]
}