| POST | /api/customerMaster/search/owner | Search customer master based on search parameters |
|---|
"use strict";
/** @typedef {'ASC'|'DESC'} */
export var ORDER;
(function (ORDER) {
ORDER["ASC"] = "ASC"
ORDER["DESC"] = "DESC"
})(ORDER || (ORDER = {}));
export class SearchCustomerMasterQuery {
/** @param {{continuationToken?:string,payByEntityIdentification?:string,requestedPage?:number,numberOfRecordsPerPage?:number,orderBy?:string,order?:ORDER}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
continuationToken;
/** @type {?string} */
payByEntityIdentification;
/** @type {number} */
requestedPage;
/** @type {number} */
numberOfRecordsPerPage;
/** @type {string} */
orderBy;
/** @type {ORDER} */
order;
}
export class SearchCustomerMaster {
/** @param {{query?:SearchCustomerMasterQuery}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {SearchCustomerMasterQuery}
* @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 SearchCustomerMaster DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/customerMaster/search/owner HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
query:
{
continuationToken: String,
payByEntityIdentification: String,
requestedPage: 0,
numberOfRecordsPerPage: 0,
orderBy: String,
order: ASC
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
continuationToken: String,
startIndex: 0,
endIndex: 0,
numberOfRecordsReturned: 0,
totalNumberOfPages: 0,
totalNumberOfRecords: 0,
results:
[
{
}
]
}