DX STF Client API

SearchClaim

Claim Requests

Claim

The following routes are available for this service:
POST	/api/claim/search	Search for claims based on parameters

**SearchClaim** Parameters:
Name	Parameter	Data Type	Required	Description
Query	model	SearchClaimQuery	Yes

**SearchClaimQuery** Parameters:
Name	Parameter	Data Type	Required
ReceiverGln	form	string	Yes
FromDate	form	DateTime	No
ToDate	form	DateTime	No
ClaimsNotificationTypeCode	form	string	Yes
ClaimsNotificationIdentification	form	string	Yes
Buyer	form	_Buyer	Yes
ClaimNotification	form	_ClaimNotification	Yes
Invoice	form	_Invoice	Yes
ExcludeLinkedToCreditNote	form	bool	No
SenderGln	form	string	Yes
PartnerGln	form	List<string>	Yes
RequestedPage	form	int	No
NumberOfRecordsPerPage	form	int	No

**_Buyer** Parameters:
Name	Parameter	Data Type	Required	Description
Gln	form	string	Yes

**_ClaimNotification** Parameters:
Name	Parameter	Data Type	Required	Description
EntityIdentification	form	string	Yes

**_Invoice** Parameters:
Name	Parameter	Data Type	Required	Description
EntityIdentification	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/claim/search HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	query: 
	{
		receiverGln: String,
		claimsNotificationTypeCode: String,
		claimsNotificationIdentification: String,
		buyer: 
		{
			gln: String
		},
		claimNotification: 
		{
			entityIdentification: String
		},
		invoice: 
		{
			entityIdentification: String
		},
		excludeLinkedToCreditNote: False,
		senderGln: String,
		partnerGln: 
		[
			String
		],
		requestedPage: 0,
		numberOfRecordsPerPage: 0
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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