GET basicroles/{id}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
id `globally unique identifier` Required Guid ID of the basic role to be read.	`globally unique identifier` Required Guid ID of the basic role to be read.

Body Parameters

None.

Response Information

Resource Description (BasicRole)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` Required on Update ID of the given basic role.	`globally unique identifier` Required on Update ID of the given basic role.
IndividualID `globally unique identifier` ID of the individual who is linked to the given basic role. (If null on create this will default to the currently logged in user.)	`globally unique identifier` ID of the individual who is linked to the given basic role. (If null on create this will default to the currently logged in user.)
Name `string` Required Name of the given basic role. (Max length 255 characters)	`string` Required Name of the given basic role. (Max length 255 characters)
Rank `integer` Rank of the given basic role.	`integer` Rank of the given basic role.
Description `string` Description of the given basic role.	`string` Description of the given basic role.
PercentTime `byte` Percent of time that should be devoted to the given basic role.	`byte` Percent of time that should be devoted to the given basic role.
Created `date` ReadOnly Date the given basic role was created.	`date` ReadOnly Date the given basic role was created.
CreatedBy `globally unique identifier` ReadOnly ID of the individual that created the given basic role.	`globally unique identifier` ReadOnly ID of the individual that created the given basic role.
Updated `date` ReadOnly Date the given basic role was last updated.	`date` ReadOnly Date the given basic role was last updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the individual that last updated the given basic role.	`globally unique identifier` ReadOnly ID of the individual that last updated the given basic role.
PerformanceIndicators `string` ReadOnly Performance indicators that are linked to the given basic role.	`string` ReadOnly Performance indicators that are linked to the given basic role.
Deleted `boolean` ReadOnly Deleted status of the given basic role.	`boolean` ReadOnly Deleted status of the given basic role.
DeletedByRef `boolean` ReadOnly Deleted by Reference status of the given basic role.	`boolean` ReadOnly Deleted by Reference status of the given basic role.

Response Formats

application/xml, text/xml

Sample

<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>6435e1f4-9a1a-4fe1-a28e-ffb4246516bb</ID>
  <IndividualID>b8072acd-f612-4b19-851f-7a229b7e55fd</IndividualID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <Description>sample string 2</Description>
  <PercentTime>64</PercentTime>
  <Created>2024-10-23T13:21:33.5496261+00:00</Created>
  <CreatedBy>43e31335-0ae7-40dc-9cb6-637d11f4fe0c</CreatedBy>
  <Updated>2024-10-23T13:21:33.5496261+00:00</Updated>
  <UpdatedBy>48c3f5c7-0a48-4cad-babe-4d0f30a42def</UpdatedBy>
  <PerformanceIndicators>sample string 3</PerformanceIndicators>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</BasicRole>

application/json, text/json

Sample

{
  "ID": "6435e1f4-9a1a-4fe1-a28e-ffb4246516bb",
  "IndividualID": "b8072acd-f612-4b19-851f-7a229b7e55fd",
  "Name": "sample string 1",
  "Rank": 1,
  "Description": "sample string 2",
  "PercentTime": 64,
  "Created": "2024-10-23T13:21:33.5496261+00:00",
  "CreatedBy": "43e31335-0ae7-40dc-9cb6-637d11f4fe0c",
  "Updated": "2024-10-23T13:21:33.5496261+00:00",
  "UpdatedBy": "48c3f5c7-0a48-4cad-babe-4d0f30a42def",
  "PerformanceIndicators": "sample string 3",
  "Deleted": true,
  "DeletedByRef": true
}