GET v2/Roles/ByCustomerType/{customerTypeId}

Get all Roles visible to the authenticated user that can be applied to the target customer type.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerTypeId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.Role

Name	Description	Type	Additional information
RoleId	Unique identifier for this role.	integer	None.
RoleTypeId	Unique identifier for the type of this role.	integer	None.
ApplicationId	Unique identifier of the application this role applies to.	integer	None.
OwningCustomerId	Unique identifier of the customer that originally created this role and owns the definition of the role.	integer	None.
CustomerId	When supplied indicates that this role identifies all capabilities that are available to the identified customer to assign to their users. This is the role created when a child customer is created with the (Custom) administrative role in the portal.	integer	None.
CustomerTypeId	When supplied indicates the unique identifier of the type of customer this role may be applied to. Will only be set on roles of the shared role type.	integer	None.
Name	Name for this role.	string	None.
Description	Description of this role.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RoleId": 1,
    "RoleTypeId": 2,
    "ApplicationId": 3,
    "OwningCustomerId": 4,
    "CustomerId": 1,
    "CustomerTypeId": 1,
    "Name": "sample string 5",
    "Description": "sample string 6"
  },
  {
    "RoleId": 1,
    "RoleTypeId": 2,
    "ApplicationId": 3,
    "OwningCustomerId": 4,
    "CustomerId": 1,
    "CustomerTypeId": 1,
    "Name": "sample string 5",
    "Description": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRole xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Role>
    <RoleId>1</RoleId>
    <RoleTypeId>2</RoleTypeId>
    <ApplicationId>3</ApplicationId>
    <OwningCustomerId>4</OwningCustomerId>
    <CustomerId>1</CustomerId>
    <CustomerTypeId>1</CustomerTypeId>
    <Name>sample string 5</Name>
    <Description>sample string 6</Description>
  </Role>
  <Role>
    <RoleId>1</RoleId>
    <RoleTypeId>2</RoleTypeId>
    <ApplicationId>3</ApplicationId>
    <OwningCustomerId>4</OwningCustomerId>
    <CustomerId>1</CustomerId>
    <CustomerTypeId>1</CustomerTypeId>
    <Name>sample string 5</Name>
    <Description>sample string 6</Description>
  </Role>
</ArrayOfRole>