DX STF Client API

<back to all web services

UpdateClaimLinkedCreditNote

Claim Requests

Claim

Requires Authentication
The following routes are available for this service:
PUT/api/claim/{claimId}/creditNote/{creditNoteId}/linkUpdate claim linked to matching credit note

/** @description Claim */
// @Api(Description="Claim")
// @ApiResponse(Description="Claim linked", IsDefaultResponse=true, StatusCode=204)
// @ApiResponse(Description="Claim not found", StatusCode=404)
export class UpdateClaimLinkedCreditNote
{
    // @ApiMember(Name="claimId")
    public claimId: string;

    // @ApiMember(Name="creditNoteId")
    public creditNoteId: string;

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

TypeScript UpdateClaimLinkedCreditNote DTOs

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

HTTP + XML

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

PUT /api/claim/{claimId}/creditNote/{creditNoteId}/link HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateClaimLinkedCreditNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.Claim">
  <ClaimId>00000000-0000-0000-0000-000000000000</ClaimId>
  <CreditNoteId>00000000-0000-0000-0000-000000000000</CreditNoteId>
</UpdateClaimLinkedCreditNote>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />