GET api/customer/roles

Get all customer roles list.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/customer/roles. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of customer roles and its all values.

Collection of CustomerRoleDto

Name	Description	Type
CURoleID	Unique Identifier of a Customer Role.	byte
Code	Code of Customer role.	string
Description	Description of Customer Role.	string
DefaultItem	Indicates whether the role is default or not.	boolean
Active	Indicates whether the role is active or not.	boolean
UniqueRestriction	Indicates whether the role has unique restriction or not.	boolean
IsGroupHead	Indicates whether the role is head for a group customer or not.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "cuRoleID": 64,
    "code": "sample string 1",
    "description": "sample string 2",
    "defaultItem": true,
    "active": true,
    "uniqueRestriction": true,
    "isGroupHead": true
  },
  {
    "cuRoleID": 64,
    "code": "sample string 1",
    "description": "sample string 2",
    "defaultItem": true,
    "active": true,
    "uniqueRestriction": true,
    "isGroupHead": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerRoleDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU.Customer">
  <CustomerRoleDto>
    <Active>true</Active>
    <CURoleID>64</CURoleID>
    <Code>sample string 1</Code>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
    <IsGroupHead>true</IsGroupHead>
    <UniqueRestriction>true</UniqueRestriction>
  </CustomerRoleDto>
  <CustomerRoleDto>
    <Active>true</Active>
    <CURoleID>64</CURoleID>
    <Code>sample string 1</Code>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
    <IsGroupHead>true</IsGroupHead>
    <UniqueRestriction>true</UniqueRestriction>
  </CustomerRoleDto>
</ArrayOfCustomerRoleDto>