DX STF Client API

GetOrderResponseByType

Order Response Requests

Order Response

The following routes are available for this service:
GET	/api/orderResponse/type/{Type}	Get paged OrderResponse response by type

**GetOrderResponseByType** Parameters:
Name	Parameter	Data Type	Required	Description
SearchTerm	query	string	Yes	Not used
RequestedPage	query	int	No	Requested page number, starting at 1
NumberOfRecordsPerPage	query	int	No	Number of records to return on a page
Type	path	string	Yes	OrderResponse type to be returned

**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.

GET /api/orderResponse/type/{Type} 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":[{}]}