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


export class _Buyer implements IBuyer
{
    public gln: string;

    public constructor(init?: Partial<_Buyer>) { (Object as any).assign(this, init); }
}

export class _ClaimNotification implements IClaimNotification
{
    public entityIdentification: string;

    public constructor(init?: Partial<_ClaimNotification>) { (Object as any).assign(this, init); }
}

export class _Invoice implements IInvoice
{
    public entityIdentification: string;

    public constructor(init?: Partial<_Invoice>) { (Object as any).assign(this, init); }
}

export class SearchClaimQuery
{
    public receiverGln: string;
    public fromDate: string;
    public toDate: string;
    public claimsNotificationTypeCode: string;
    public claimsNotificationIdentification: string;
    public buyer: _Buyer;
    public claimNotification: _ClaimNotification;
    public invoice: _Invoice;
    public excludeLinkedToCreditNote: boolean;
    public senderGln: string;
    public partnerGln: string[] = [];
    public requestedPage: number;
    public numberOfRecordsPerPage: number;

    public constructor(init?: Partial<SearchClaimQuery>) { (Object as any).assign(this, init); }
}

/** @description Claim */
// @Api(Description="Claim")
// @ApiResponse(Description="Claim search results", StatusCode=200)
export class SearchClaim
{
    // @ApiMember(ParameterType="model")
    public query: SearchClaimQuery;

    public constructor(init?: Partial<SearchClaim>) { (Object as any).assign(this, init); }
}

export class PagedQueryResult<T>
{
    public startIndex: number;
    public endIndex: number;
    public numberOfRecordsReturned: number;
    public totalNumberOfPages: number;
    public totalNumberOfRecords: number;
    public results: ResultItem<ClaimMessage>[] = [];

    public constructor(init?: Partial<PagedQueryResult<T>>) { (Object as any).assign(this, init); }
}

TypeScript SearchClaim DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

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