DX STF Client API

SearchSenderPurchaseCondition

Purchase Conditions Requests

Purchase Conditions

The following routes are available for this service:
POST	/api/purchaseCondition/search/sender	Search purchase condition based on search parameters

**SearchSenderPurchaseCondition** Parameters:
Name	Parameter	Data Type	Required	Description
Query	model	SearchPurchaseConditionByDateFilter	Yes	Search query

**SearchPurchaseConditionByDateFilter** Parameters:
Name	Parameter	Data Type	Required
FromDate	form	DateTime	No
ToDate	form	DateTime	No
ContinuationToken	form	string	Yes
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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/purchaseCondition/search/sender HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	query: 
	{
		continuationToken: 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: 
	[
		{
			
		}
	]
}