PUT ItemRoles/{id}

Updates ItemRole name, description and replaces existing subcategories


Parameters

NameDescriptionAdditional information
id 
The Id of the ItemRole to edit.

Define this parameter in the request URI.
request 
The ItemRole to edit.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "ItemRoleId": 1,
  "RoleName": "sample string 2",
  "Description": "sample string 3",
  "SubCatItemRoles": [
    {
      "ItemRoleSubCatId": 1,
      "SubCatId": 2,
      "AddToTemplate": true,
      "MaximumAllowedWithReceipt": 4.0,
      "MaximumAllowedWithoutReceipt": 5.0
    },
    {
      "ItemRoleSubCatId": 1,
      "SubCatId": 2,
      "AddToTemplate": true,
      "MaximumAllowedWithReceipt": 4.0,
      "MaximumAllowedWithoutReceipt": 5.0
    },
    {
      "ItemRoleSubCatId": 1,
      "SubCatId": 2,
      "AddToTemplate": true,
      "MaximumAllowedWithReceipt": 4.0,
      "MaximumAllowedWithoutReceipt": 5.0
    }
  ]
}

application/xml, text/xml

Sample: 
<ItemRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <Description>sample string 3</Description>
  <ItemRoleId>1</ItemRoleId>
  <RoleName>sample string 2</RoleName>
  <SubCatItemRoles>
    <SubCatItemRole>
      <AddToTemplate>true</AddToTemplate>
      <ItemRoleSubCatId>1</ItemRoleSubCatId>
      <MaximumAllowedWithReceipt>4</MaximumAllowedWithReceipt>
      <MaximumAllowedWithoutReceipt>5</MaximumAllowedWithoutReceipt>
      <SubCatId>2</SubCatId>
    </SubCatItemRole>
    <SubCatItemRole>
      <AddToTemplate>true</AddToTemplate>
      <ItemRoleSubCatId>1</ItemRoleSubCatId>
      <MaximumAllowedWithReceipt>4</MaximumAllowedWithReceipt>
      <MaximumAllowedWithoutReceipt>5</MaximumAllowedWithoutReceipt>
      <SubCatId>2</SubCatId>
    </SubCatItemRole>
    <SubCatItemRole>
      <AddToTemplate>true</AddToTemplate>
      <ItemRoleSubCatId>1</ItemRoleSubCatId>
      <MaximumAllowedWithReceipt>4</MaximumAllowedWithReceipt>
      <MaximumAllowedWithoutReceipt>5</MaximumAllowedWithoutReceipt>
      <SubCatId>2</SubCatId>
    </SubCatItemRole>
  </SubCatItemRoles>
</ItemRole>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

An ItemRoleResponse containing the edited ItemRole and associated sub categories

application/json, text/json

Sample: 
{
  "Item": {
    "ItemRoleId": 1,
    "RoleName": "sample string 2",
    "Description": "sample string 3",
    "SubCatItemRoles": [
      {
        "ItemRoleSubCatId": 1,
        "SubCatId": 2,
        "AddToTemplate": true,
        "MaximumAllowedWithReceipt": 4.0,
        "MaximumAllowedWithoutReceipt": 5.0
      },
      {
        "ItemRoleSubCatId": 1,
        "SubCatId": 2,
        "AddToTemplate": true,
        "MaximumAllowedWithReceipt": 4.0,
        "MaximumAllowedWithoutReceipt": 5.0
      },
      {
        "ItemRoleSubCatId": 1,
        "SubCatId": 2,
        "AddToTemplate": true,
        "MaximumAllowedWithReceipt": 4.0,
        "MaximumAllowedWithoutReceipt": 5.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: 
<ItemRoleResponse 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:Description>sample string 3</d2p1:Description>
    <d2p1:ItemRoleId>1</d2p1:ItemRoleId>
    <d2p1:RoleName>sample string 2</d2p1:RoleName>
    <d2p1:SubCatItemRoles>
      <d2p1:SubCatItemRole>
        <d2p1:AddToTemplate>true</d2p1:AddToTemplate>
        <d2p1:ItemRoleSubCatId>1</d2p1:ItemRoleSubCatId>
        <d2p1:MaximumAllowedWithReceipt>4</d2p1:MaximumAllowedWithReceipt>
        <d2p1:MaximumAllowedWithoutReceipt>5</d2p1:MaximumAllowedWithoutReceipt>
        <d2p1:SubCatId>2</d2p1:SubCatId>
      </d2p1:SubCatItemRole>
      <d2p1:SubCatItemRole>
        <d2p1:AddToTemplate>true</d2p1:AddToTemplate>
        <d2p1:ItemRoleSubCatId>1</d2p1:ItemRoleSubCatId>
        <d2p1:MaximumAllowedWithReceipt>4</d2p1:MaximumAllowedWithReceipt>
        <d2p1:MaximumAllowedWithoutReceipt>5</d2p1:MaximumAllowedWithoutReceipt>
        <d2p1:SubCatId>2</d2p1:SubCatId>
      </d2p1:SubCatItemRole>
      <d2p1:SubCatItemRole>
        <d2p1:AddToTemplate>true</d2p1:AddToTemplate>
        <d2p1:ItemRoleSubCatId>1</d2p1:ItemRoleSubCatId>
        <d2p1:MaximumAllowedWithReceipt>4</d2p1:MaximumAllowedWithReceipt>
        <d2p1:MaximumAllowedWithoutReceipt>5</d2p1:MaximumAllowedWithoutReceipt>
        <d2p1:SubCatId>2</d2p1:SubCatId>
      </d2p1:SubCatItemRole>
    </d2p1:SubCatItemRoles>
  </Item>
</ItemRoleResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body