DX STF Client API

SearchCustomerMaster

Customer Master Requests

Customer Master

The following routes are available for this service:
POST	/api/customerMaster/search/owner	Search customer master based on search parameters

**SearchCustomerMaster** Parameters:
Name	Parameter	Data Type	Required	Description
Query	model	SearchCustomerMasterQuery	Yes	Search query

**SearchCustomerMasterQuery** Parameters:
Name	Parameter	Data Type	Required
ContinuationToken	form	string	Yes
PayByEntityIdentification	form	string	No
RequestedPage	form	int	No
NumberOfRecordsPerPage	form	int	No
OrderBy	form	string	Yes
Order	form	ORDER	No

**ORDER** Enum:
ASC
DESC

**PagedQueryResponseWithToken<T>** Parameters:
Name	Parameter	Data Type	Required	Description
ContinuationToken	form	string	Yes

**PagedQueryResult<T>** Parameters:
Name	Parameter	Data Type	Required
StartIndex	form	long	No
EndIndex	form	long	No
NumberOfRecordsReturned	form	int	No
TotalNumberOfPages	form	int	No
TotalNumberOfRecords	form	long	No
Results	form	List<ResultItem<ClaimMessage>>	Yes

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

HTTP + 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":[{}]}