GET AccessRoles/{id}

Gets a single AccessRole, by its Id.


Parameters

NameDescriptionAdditional information
id
The Id of the item to get.

Define this parameter in the request URI.

Response body formats

An AccessRolesResponse object containing the matching AccessRole.

application/json, text/json

Sample:
{
  "Item": {
    "Id": 1,
    "Label": "sample string 2",
    "Description": "sample string 3",
    "ElementAccess": [
      {
        "Id": 1,
        "Label": "sample string 2",
        "AccessRights": {
          "CanView": true,
          "CanAdd": true,
          "CanEdit": true,
          "CanDelete": true
        }
      },
      {
        "Id": 1,
        "Label": "sample string 2",
        "AccessRights": {
          "CanView": true,
          "CanAdd": true,
          "CanEdit": true,
          "CanDelete": true
        }
      },
      {
        "Id": 1,
        "Label": "sample string 2",
        "AccessRights": {
          "CanView": true,
          "CanAdd": true,
          "CanEdit": true,
          "CanDelete": true
        }
      }
    ],
    "ExpenseClaimMinimumAmount": 1.0,
    "ExpenseClaimMaximumAmount": 1.0,
    "AccessLevel": 1,
    "AccessRoleLinks": [
      1,
      2,
      3
    ],
    "CanEditCostCode": true,
    "CanEditDepartment": true,
    "CanEditProjectCode": true,
    "MustHaveBankAccount": true,
    "CustomEntityAccess": [
      {
        "Id": 1,
        "CustomEntityName": "sample string 2",
        "AccessRights": {
          "CanView": true,
          "CanAdd": true,
          "CanEdit": true,
          "CanDelete": true
        },
        "ElementAccess": [
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          },
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          },
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          }
        ]
      },
      {
        "Id": 1,
        "CustomEntityName": "sample string 2",
        "AccessRights": {
          "CanView": true,
          "CanAdd": true,
          "CanEdit": true,
          "CanDelete": true
        },
        "ElementAccess": [
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          },
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          },
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          }
        ]
      },
      {
        "Id": 1,
        "CustomEntityName": "sample string 2",
        "AccessRights": {
          "CanView": true,
          "CanAdd": true,
          "CanEdit": true,
          "CanDelete": true
        },
        "ElementAccess": [
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          },
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          },
          {
            "Id": 1,
            "CustomEntityId": 2,
            "Type": 0,
            "AccessRights": {
              "CanView": true,
              "CanAdd": true,
              "CanEdit": true,
              "CanDelete": true
            }
          }
        ]
      }
    ],
    "AllowWebsiteAccess": true,
    "AllowMobileAccess": true,
    "AllowApiAccess": 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:
<AccessRoleResponse 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:AccessLevel>EmployeesResponsibleFor</d2p1:AccessLevel>
    <d2p1:AccessRoleLinks xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
      <d3p1:int>3</d3p1:int>
    </d2p1:AccessRoleLinks>
    <d2p1:AllowApiAccess>true</d2p1:AllowApiAccess>
    <d2p1:AllowMobileAccess>true</d2p1:AllowMobileAccess>
    <d2p1:AllowWebsiteAccess>true</d2p1:AllowWebsiteAccess>
    <d2p1:CanEditCostCode>true</d2p1:CanEditCostCode>
    <d2p1:CanEditDepartment>true</d2p1:CanEditDepartment>
    <d2p1:CanEditProjectCode>true</d2p1:CanEditProjectCode>
    <d2p1:CustomEntityAccess>
      <d2p1:CustomEntityGroupAccess>
        <d2p1:AccessRights>
          <d2p1:CanAdd>true</d2p1:CanAdd>
          <d2p1:CanDelete>true</d2p1:CanDelete>
          <d2p1:CanEdit>true</d2p1:CanEdit>
          <d2p1:CanView>true</d2p1:CanView>
        </d2p1:AccessRights>
        <d2p1:CustomEntityName>sample string 2</d2p1:CustomEntityName>
        <d2p1:ElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
        </d2p1:ElementAccess>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:CustomEntityGroupAccess>
      <d2p1:CustomEntityGroupAccess>
        <d2p1:AccessRights>
          <d2p1:CanAdd>true</d2p1:CanAdd>
          <d2p1:CanDelete>true</d2p1:CanDelete>
          <d2p1:CanEdit>true</d2p1:CanEdit>
          <d2p1:CanView>true</d2p1:CanView>
        </d2p1:AccessRights>
        <d2p1:CustomEntityName>sample string 2</d2p1:CustomEntityName>
        <d2p1:ElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
        </d2p1:ElementAccess>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:CustomEntityGroupAccess>
      <d2p1:CustomEntityGroupAccess>
        <d2p1:AccessRights>
          <d2p1:CanAdd>true</d2p1:CanAdd>
          <d2p1:CanDelete>true</d2p1:CanDelete>
          <d2p1:CanEdit>true</d2p1:CanEdit>
          <d2p1:CanView>true</d2p1:CanView>
        </d2p1:AccessRights>
        <d2p1:CustomEntityName>sample string 2</d2p1:CustomEntityName>
        <d2p1:ElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
          <d2p1:CustomEntityElementAccess>
            <d2p1:AccessRights>
              <d2p1:CanAdd>true</d2p1:CanAdd>
              <d2p1:CanDelete>true</d2p1:CanDelete>
              <d2p1:CanEdit>true</d2p1:CanEdit>
              <d2p1:CanView>true</d2p1:CanView>
            </d2p1:AccessRights>
            <d2p1:CustomEntityId>2</d2p1:CustomEntityId>
            <d2p1:Id>1</d2p1:Id>
            <d2p1:Type>None</d2p1:Type>
          </d2p1:CustomEntityElementAccess>
        </d2p1:ElementAccess>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:CustomEntityGroupAccess>
    </d2p1:CustomEntityAccess>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:ElementAccess>
      <d2p1:ElementAccessDetail>
        <d2p1:AccessRights>
          <d2p1:CanAdd>true</d2p1:CanAdd>
          <d2p1:CanDelete>true</d2p1:CanDelete>
          <d2p1:CanEdit>true</d2p1:CanEdit>
          <d2p1:CanView>true</d2p1:CanView>
        </d2p1:AccessRights>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Label>sample string 2</d2p1:Label>
      </d2p1:ElementAccessDetail>
      <d2p1:ElementAccessDetail>
        <d2p1:AccessRights>
          <d2p1:CanAdd>true</d2p1:CanAdd>
          <d2p1:CanDelete>true</d2p1:CanDelete>
          <d2p1:CanEdit>true</d2p1:CanEdit>
          <d2p1:CanView>true</d2p1:CanView>
        </d2p1:AccessRights>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Label>sample string 2</d2p1:Label>
      </d2p1:ElementAccessDetail>
      <d2p1:ElementAccessDetail>
        <d2p1:AccessRights>
          <d2p1:CanAdd>true</d2p1:CanAdd>
          <d2p1:CanDelete>true</d2p1:CanDelete>
          <d2p1:CanEdit>true</d2p1:CanEdit>
          <d2p1:CanView>true</d2p1:CanView>
        </d2p1:AccessRights>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Label>sample string 2</d2p1:Label>
      </d2p1:ElementAccessDetail>
    </d2p1:ElementAccess>
    <d2p1:ExpenseClaimMaximumAmount>1</d2p1:ExpenseClaimMaximumAmount>
    <d2p1:ExpenseClaimMinimumAmount>1</d2p1:ExpenseClaimMinimumAmount>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Label>sample string 2</d2p1:Label>
    <d2p1:MustHaveBankAccount>true</d2p1:MustHaveBankAccount>
  </Item>
</AccessRoleResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body