DX STF Client API

<back to all web services

SearchSenderPurchaseCondition

Purchase Conditions Requests

Purchase Conditions

Requires Authentication
The following routes are available for this service:
POST/api/purchaseCondition/search/senderSearch purchase condition based on search parameters
"use strict";
/** @typedef {'ASC'|'DESC'} */
export var ORDER;
(function (ORDER) {
    ORDER["ASC"] = "ASC"
    ORDER["DESC"] = "DESC"
})(ORDER || (ORDER = {}));
export class SearchPurchaseConditionByDateFilter {
    /** @param {{fromDate?:string,toDate?:string,continuationToken?:string,requestedPage?:number,numberOfRecordsPerPage?:number,orderBy?:string,order?:ORDER}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    fromDate;
    /** @type {string} */
    toDate;
    /** @type {string} */
    continuationToken;
    /** @type {number} */
    requestedPage;
    /** @type {number} */
    numberOfRecordsPerPage;
    /** @type {string} */
    orderBy;
    /** @type {ORDER} */
    order;
}
export class SearchSenderPurchaseCondition {
    /** @param {{query?:SearchPurchaseConditionByDateFilter}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {SearchPurchaseConditionByDateFilter}
     * @description Search query */
    query;
}
/** @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 = [];
}
/** @typedef T {any} */
export class PagedQueryResponseWithToken extends PagedQueryResult {
    /** @param {{continuationToken?:string,startIndex?:number,endIndex?:number,numberOfRecordsReturned?:number,totalNumberOfPages?:number,totalNumberOfRecords?:number,results?:ResultItem<ClaimMessage>[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    continuationToken;
}

JavaScript SearchSenderPurchaseCondition 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.

POST /api/purchaseCondition/search/sender HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"query":{"continuationToken":"String","requestedPage":0,"numberOfRecordsPerPage":0,"orderBy":"String","order":"ASC"}}

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

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