GET Claims/GetClaimDefinition?id={id}

Gets a single ClaimDefinitionResponse, by its Id.


Parameters

NameDescriptionAdditional information
id 
The Id of the ClaimDefinition to get.

Define this parameter in the request URI.

Response body formats

A ClaimDefinitionResponse, containing the claim name, description and user defined field information.

application/json, text/json

Sample: 
{
  "Item": {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "UserDefinedFields": [
      {
        "UserDefinedFieldId": 1,
        "Attribute": {
          "Attributeid": 1,
          "Attributename": "sample string 2",
          "Displayname": "sample string 3",
          "Description": "sample string 4",
          "Tooltip": "sample string 5",
          "Mandatory": true,
          "DisplayInMobile": true,
          "Fieldtype": 1,
          "Createdon": "2025-01-26T07:13:03.8600181+00:00",
          "Createdby": 9,
          "Modifiedon": "2025-01-26T07:13:03.8600181+00:00",
          "Modifiedby": 1,
          "Fieldid": "752b7f77-8061-4882-acb9-fc5844484c2b",
          "Iskeyfield": true,
          "Isauditidentifer": true,
          "Isunique": true,
          "AllowEdit": true,
          "AllowDelete": true,
          "IsSystemAttribute": true,
          "BoolAttribute": true,
          "MaxLength": 18,
          "FieldFormat": 0,
          "Precision": 19,
          "HyperLink": null,
          "DefautCheckValue": "sample string 20",
          "ListElements": [
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            },
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            },
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            }
          ]
        },
        "Value": {},
        "Order": 3,
        "AllowEmployeeToPopulate": true
      },
      {
        "UserDefinedFieldId": 1,
        "Attribute": {
          "Attributeid": 1,
          "Attributename": "sample string 2",
          "Displayname": "sample string 3",
          "Description": "sample string 4",
          "Tooltip": "sample string 5",
          "Mandatory": true,
          "DisplayInMobile": true,
          "Fieldtype": 1,
          "Createdon": "2025-01-26T07:13:03.8600181+00:00",
          "Createdby": 9,
          "Modifiedon": "2025-01-26T07:13:03.8600181+00:00",
          "Modifiedby": 1,
          "Fieldid": "752b7f77-8061-4882-acb9-fc5844484c2b",
          "Iskeyfield": true,
          "Isauditidentifer": true,
          "Isunique": true,
          "AllowEdit": true,
          "AllowDelete": true,
          "IsSystemAttribute": true,
          "BoolAttribute": true,
          "MaxLength": 18,
          "FieldFormat": 0,
          "Precision": 19,
          "HyperLink": null,
          "DefautCheckValue": "sample string 20",
          "ListElements": [
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            },
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            },
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            }
          ]
        },
        "Value": {},
        "Order": 3,
        "AllowEmployeeToPopulate": true
      },
      {
        "UserDefinedFieldId": 1,
        "Attribute": {
          "Attributeid": 1,
          "Attributename": "sample string 2",
          "Displayname": "sample string 3",
          "Description": "sample string 4",
          "Tooltip": "sample string 5",
          "Mandatory": true,
          "DisplayInMobile": true,
          "Fieldtype": 1,
          "Createdon": "2025-01-26T07:13:03.8600181+00:00",
          "Createdby": 9,
          "Modifiedon": "2025-01-26T07:13:03.8600181+00:00",
          "Modifiedby": 1,
          "Fieldid": "752b7f77-8061-4882-acb9-fc5844484c2b",
          "Iskeyfield": true,
          "Isauditidentifer": true,
          "Isunique": true,
          "AllowEdit": true,
          "AllowDelete": true,
          "IsSystemAttribute": true,
          "BoolAttribute": true,
          "MaxLength": 18,
          "FieldFormat": 0,
          "Precision": 19,
          "HyperLink": null,
          "DefautCheckValue": "sample string 20",
          "ListElements": [
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            },
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            },
            {
              "ElementValue": 1,
              "ElementText": "sample string 2",
              "ElementOrder": 3,
              "Archived": true
            }
          ]
        },
        "Value": {},
        "Order": 3,
        "AllowEmployeeToPopulate": true
      }
    ],
    "ClaimDefinitionOutcome": 0
  },
  "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: 
<ClaimDefinitionResponse 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.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:ClaimDefinitionOutcome>SingleClaimOnly</d2p1:ClaimDefinitionOutcome>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:UserDefinedFields>
      <d2p1:UserDefinedFieldType>
        <d2p1:AllowEmployeeToPopulate>true</d2p1:AllowEmployeeToPopulate>
        <d2p1:Attribute>
          <d2p1:AllowDelete>true</d2p1:AllowDelete>
          <d2p1:AllowEdit>true</d2p1:AllowEdit>
          <d2p1:Attributeid>1</d2p1:Attributeid>
          <d2p1:Attributename>sample string 2</d2p1:Attributename>
          <d2p1:BoolAttribute>true</d2p1:BoolAttribute>
          <d2p1:Createdby>9</d2p1:Createdby>
          <d2p1:Createdon>2025-01-26T07:13:03.8600181+00:00</d2p1:Createdon>
          <d2p1:DefautCheckValue>sample string 20</d2p1:DefautCheckValue>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:DisplayInMobile>true</d2p1:DisplayInMobile>
          <d2p1:Displayname>sample string 3</d2p1:Displayname>
          <d2p1:FieldFormat>NotSet</d2p1:FieldFormat>
          <d2p1:Fieldid>752b7f77-8061-4882-acb9-fc5844484c2b</d2p1:Fieldid>
          <d2p1:Fieldtype>Text</d2p1:Fieldtype>
          <d2p1:HyperLink xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.Web.UI.WebControls" i:nil="true" />
          <d2p1:IsSystemAttribute>true</d2p1:IsSystemAttribute>
          <d2p1:Isauditidentifer>true</d2p1:Isauditidentifer>
          <d2p1:Iskeyfield>true</d2p1:Iskeyfield>
          <d2p1:Isunique>true</d2p1:Isunique>
          <d2p1:ListElements xmlns:d6p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Employees">
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
          </d2p1:ListElements>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:MaxLength>18</d2p1:MaxLength>
          <d2p1:Modifiedby>1</d2p1:Modifiedby>
          <d2p1:Modifiedon>2025-01-26T07:13:03.8600181+00:00</d2p1:Modifiedon>
          <d2p1:Precision>19</d2p1:Precision>
          <d2p1:Tooltip>sample string 5</d2p1:Tooltip>
        </d2p1:Attribute>
        <d2p1:Order>3</d2p1:Order>
        <d2p1:UserDefinedFieldId>1</d2p1:UserDefinedFieldId>
        <d2p1:Value />
      </d2p1:UserDefinedFieldType>
      <d2p1:UserDefinedFieldType>
        <d2p1:AllowEmployeeToPopulate>true</d2p1:AllowEmployeeToPopulate>
        <d2p1:Attribute>
          <d2p1:AllowDelete>true</d2p1:AllowDelete>
          <d2p1:AllowEdit>true</d2p1:AllowEdit>
          <d2p1:Attributeid>1</d2p1:Attributeid>
          <d2p1:Attributename>sample string 2</d2p1:Attributename>
          <d2p1:BoolAttribute>true</d2p1:BoolAttribute>
          <d2p1:Createdby>9</d2p1:Createdby>
          <d2p1:Createdon>2025-01-26T07:13:03.8600181+00:00</d2p1:Createdon>
          <d2p1:DefautCheckValue>sample string 20</d2p1:DefautCheckValue>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:DisplayInMobile>true</d2p1:DisplayInMobile>
          <d2p1:Displayname>sample string 3</d2p1:Displayname>
          <d2p1:FieldFormat>NotSet</d2p1:FieldFormat>
          <d2p1:Fieldid>752b7f77-8061-4882-acb9-fc5844484c2b</d2p1:Fieldid>
          <d2p1:Fieldtype>Text</d2p1:Fieldtype>
          <d2p1:HyperLink xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.Web.UI.WebControls" i:nil="true" />
          <d2p1:IsSystemAttribute>true</d2p1:IsSystemAttribute>
          <d2p1:Isauditidentifer>true</d2p1:Isauditidentifer>
          <d2p1:Iskeyfield>true</d2p1:Iskeyfield>
          <d2p1:Isunique>true</d2p1:Isunique>
          <d2p1:ListElements xmlns:d6p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Employees">
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
          </d2p1:ListElements>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:MaxLength>18</d2p1:MaxLength>
          <d2p1:Modifiedby>1</d2p1:Modifiedby>
          <d2p1:Modifiedon>2025-01-26T07:13:03.8600181+00:00</d2p1:Modifiedon>
          <d2p1:Precision>19</d2p1:Precision>
          <d2p1:Tooltip>sample string 5</d2p1:Tooltip>
        </d2p1:Attribute>
        <d2p1:Order>3</d2p1:Order>
        <d2p1:UserDefinedFieldId>1</d2p1:UserDefinedFieldId>
        <d2p1:Value />
      </d2p1:UserDefinedFieldType>
      <d2p1:UserDefinedFieldType>
        <d2p1:AllowEmployeeToPopulate>true</d2p1:AllowEmployeeToPopulate>
        <d2p1:Attribute>
          <d2p1:AllowDelete>true</d2p1:AllowDelete>
          <d2p1:AllowEdit>true</d2p1:AllowEdit>
          <d2p1:Attributeid>1</d2p1:Attributeid>
          <d2p1:Attributename>sample string 2</d2p1:Attributename>
          <d2p1:BoolAttribute>true</d2p1:BoolAttribute>
          <d2p1:Createdby>9</d2p1:Createdby>
          <d2p1:Createdon>2025-01-26T07:13:03.8600181+00:00</d2p1:Createdon>
          <d2p1:DefautCheckValue>sample string 20</d2p1:DefautCheckValue>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:DisplayInMobile>true</d2p1:DisplayInMobile>
          <d2p1:Displayname>sample string 3</d2p1:Displayname>
          <d2p1:FieldFormat>NotSet</d2p1:FieldFormat>
          <d2p1:Fieldid>752b7f77-8061-4882-acb9-fc5844484c2b</d2p1:Fieldid>
          <d2p1:Fieldtype>Text</d2p1:Fieldtype>
          <d2p1:HyperLink xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.Web.UI.WebControls" i:nil="true" />
          <d2p1:IsSystemAttribute>true</d2p1:IsSystemAttribute>
          <d2p1:Isauditidentifer>true</d2p1:Isauditidentifer>
          <d2p1:Iskeyfield>true</d2p1:Iskeyfield>
          <d2p1:Isunique>true</d2p1:Isunique>
          <d2p1:ListElements xmlns:d6p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Employees">
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
            <d6p1:UserDefinedFieldListElement>
              <d6p1:Archived>true</d6p1:Archived>
              <d6p1:ElementOrder>3</d6p1:ElementOrder>
              <d6p1:ElementText>sample string 2</d6p1:ElementText>
              <d6p1:ElementValue>1</d6p1:ElementValue>
            </d6p1:UserDefinedFieldListElement>
          </d2p1:ListElements>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:MaxLength>18</d2p1:MaxLength>
          <d2p1:Modifiedby>1</d2p1:Modifiedby>
          <d2p1:Modifiedon>2025-01-26T07:13:03.8600181+00:00</d2p1:Modifiedon>
          <d2p1:Precision>19</d2p1:Precision>
          <d2p1:Tooltip>sample string 5</d2p1:Tooltip>
        </d2p1:Attribute>
        <d2p1:Order>3</d2p1:Order>
        <d2p1:UserDefinedFieldId>1</d2p1:UserDefinedFieldId>
        <d2p1:Value />
      </d2p1:UserDefinedFieldType>
    </d2p1:UserDefinedFields>
  </Item>
</ClaimDefinitionResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body