| POST | /api/customerMaster/search/owner | Search customer master based on search parameters |
|---|
export enum ORDER
{
ASC = 'ASC',
DESC = 'DESC',
}
export class SearchCustomerMasterQuery implements ISearchCustomerMaster
{
public continuationToken: string;
public payByEntityIdentification?: string;
public requestedPage: number;
public numberOfRecordsPerPage: number;
public orderBy: string;
public order: ORDER;
public constructor(init?: Partial<SearchCustomerMasterQuery>) { (Object as any).assign(this, init); }
}
/** @description Customer Master */
// @Api(Description="Customer Master")
// @ApiResponse(Description="Paged Customer Master data", IsDefaultResponse=true, ResponseType="typeof(DX.STF.Models.Queries.QueryResult.PagedQueryResponseWithToken`1[[DX.Framework.Core.Querying.ResultItem`1[[DX.STF.Models.Dto.MasterData.CustomerMasterMessage, DX.STF.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], DX.Framework.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]])", StatusCode=200)
export class SearchCustomerMaster
{
/** @description Search query */
// @ApiMember(Description="Search query", ParameterType="model")
public query: SearchCustomerMasterQuery;
public constructor(init?: Partial<SearchCustomerMaster>) { (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); }
}
export class PagedQueryResponseWithToken<T> extends PagedQueryResult<ResultItem<InvoiceMessage>>
{
public continuationToken: string;
public constructor(init?: Partial<PagedQueryResponseWithToken<T>>) { super(init); (Object as any).assign(this, init); }
}
TypeScript SearchCustomerMaster DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"query":{"continuationToken":"String","payByEntityIdentification":"String","requestedPage":0,"numberOfRecordsPerPage":0,"orderBy":"String","order":"ASC"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"continuationToken":"String","startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}