POST Claims/AssignClaims

Assign the claims related to the provided claimIds to the current user.


Parameters

NameDescriptionAdditional information
request
The AssignClaimsRequest.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "ClaimIds": [
    1,
    2,
    3
  ]
}

application/xml, text/xml

Sample:
<AssignClaimsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Requests">
  <ClaimIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ClaimIds>
</AssignClaimsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

The AssignClaimsResponse

application/json, text/json

Sample:
{
  "List": [
    {
      "ClaimId": 1,
      "ClaimName": "sample string 2",
      "Success": true
    },
    {
      "ClaimId": 1,
      "ClaimName": "sample string 2",
      "Success": true
    },
    {
      "ClaimId": 1,
      "ClaimName": "sample string 2",
      "Success": true
    }
  ],
  "Item": {
    "ClaimId": 1,
    "ClaimName": "sample string 2",
    "Success": true
  },
  "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:
<AssignClaimsResponse 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:ClaimName>sample string 2</d2p1:ClaimName>
    <d2p1:Success>true</d2p1:Success>
  </Item>
  <List>
    <AssignClaim>
      <ClaimId>1</ClaimId>
      <ClaimName>sample string 2</ClaimName>
      <Success>true</Success>
    </AssignClaim>
    <AssignClaim>
      <ClaimId>1</ClaimId>
      <ClaimName>sample string 2</ClaimName>
      <Success>true</Success>
    </AssignClaim>
    <AssignClaim>
      <ClaimId>1</ClaimId>
      <ClaimName>sample string 2</ClaimName>
      <Success>true</Success>
    </AssignClaim>
  </List>
</AssignClaimsResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body