DX STF Client API

<back to all web services

GetPurchaseConditionByDateRange

Purchase Conditions Requests

Purchase Conditions

Requires Authentication
The following routes are available for this service:
GET/api/purchaseCondition/from/{FromDate}/to/{ToDate}Get Purchase Condition between start and end date
GetPurchaseConditionByDateRange Parameters:
NameParameterData TypeRequiredDescription
RequestedPagequeryintNoRequested page number, starting at 1
NumberOfRecordsPerPagequeryintNoNumber of records to return on a page
FromDatepathDateTimeNoFrom Date Time
ToDatepathDateTimeNoTo Date Time
PagedQueryResult<T> Parameters:
NameParameterData TypeRequiredDescription
StartIndexformlongNo
EndIndexformlongNo
NumberOfRecordsReturnedformintNo
TotalNumberOfPagesformintNo
TotalNumberOfRecordsformlongNo
ResultsformList<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.

GET /api/purchaseCondition/from/{FromDate}/to/{ToDate} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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