PUT Claims/ApproveClaim?claimId={claimId}

Approves a claim, sending to the next stage if applicable.


Parameters

NameDescriptionAdditional information
claimId
The claim to approve

Define this parameter in the request URI.

Response body formats

A ClaimSubmissionResponse detailing success or failure of the approval.

application/json, text/json

Sample:
{
  "Item": {
    "ClaimId": 1,
    "ClaimStatus": 0,
    "SubmitClaimResult": {
      "Reason": 0,
      "FrequencyValue": 1,
      "FrequencyPeriod": 64,
      "FlagResults": null,
      "ClaimID": 3,
      "Approver": true,
      "MinimumAmount": 1.0,
      "MaximumAmount": 1.0,
      "NewLocationURL": "sample string 5",
      "NoDefaultAuthoriserPresent": true
    },
    "ClaimSubmitRejectionReason": "sample string 2"
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ClaimSubmissionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:ClaimId>1</d2p1:ClaimId>
    <d2p1:ClaimStatus>None</d2p1:ClaimStatus>
    <d2p1:ClaimSubmitRejectionReason>sample string 2</d2p1:ClaimSubmitRejectionReason>
    <d2p1:SubmitClaimResult xmlns:d3p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
      <d3p1:Approver>true</d3p1:Approver>
      <d3p1:ClaimID>3</d3p1:ClaimID>
      <d3p1:FlagResults i:nil="true" />
      <d3p1:FrequencyPeriod>64</d3p1:FrequencyPeriod>
      <d3p1:FrequencyValue>1</d3p1:FrequencyValue>
      <d3p1:MaximumAmount>1</d3p1:MaximumAmount>
      <d3p1:MinimumAmount>1</d3p1:MinimumAmount>
      <d3p1:NewLocationURL>sample string 5</d3p1:NewLocationURL>
      <d3p1:NoDefaultAuthoriserPresent>true</d3p1:NoDefaultAuthoriserPresent>
      <d3p1:Reason>Success</d3p1:Reason>
    </d2p1:SubmitClaimResult>
  </Item>
</ClaimSubmissionResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body