GET api/role/{id}
Get a role by its Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The id of the role to get. Pass 0 to be returned an empty data contract. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The role or null if it does not exist
Dezrez.Core.DataContracts.External.Api.Role.Query.Get.RoleDataContractName | Description | Type | Additional information |
---|---|---|---|
OwningTeamId | integer |
None. |
|
BranchId | integer |
None. |
|
Name | string |
None. |
|
TeamAccessType | string |
None. |
|
RoleType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
RoleStatus | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
CustomFields | Collection of Dezrez.Core.DataContracts.External.Api.Custom.Command.SaveCustomField.CustomFieldGroupWithValuesDataContract |
None. |
|
CreatedDate | date |
None. |
|
CreatedBy | Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "OwningTeamId": 1, "BranchId": 2, "Name": "sample string 3", "TeamAccessType": "sample string 4", "RoleType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RoleStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "CustomFields": [ { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] }, { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] } ], "CreatedDate": "2024-10-06T04:54:51.0362975Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 6 }