DX STF Client API

GetPurchaseConditionByDateRange

Purchase Conditions Requests

Purchase Conditions

The following routes are available for this service:
GET	/api/purchaseCondition/from/{FromDate}/to/{ToDate}	Get Purchase Condition between start and end date

"use strict";
export class GetPurchaseConditionByDateRange {
    /** @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 GetPurchaseConditionByDateRange DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/purchaseCondition/from/{FromDate}/to/{ToDate} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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