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>489b4094-2fbf-47cf-b0c9-8559366ae290</ID>
  <IndividualID>2fa72bd3-d06d-4f94-9280-ade1534b1ed3</IndividualID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <Description>sample string 2</Description>
  <PercentTime>64</PercentTime>
  <Created>2025-02-16T01:08:37.273048+00:00</Created>
  <CreatedBy>1307f663-43fc-40bf-af05-cbf102b84813</CreatedBy>
  <Updated>2025-02-16T01:08:37.273048+00:00</Updated>
  <UpdatedBy>08773041-748e-4943-b2bf-210808d5c516</UpdatedBy>
  <PerformanceIndicators>sample string 3</PerformanceIndicators>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</BasicRole>

application/json, text/json

Sample

{
  "ID": "489b4094-2fbf-47cf-b0c9-8559366ae290",
  "IndividualID": "2fa72bd3-d06d-4f94-9280-ade1534b1ed3",
  "Name": "sample string 1",
  "Rank": 1,
  "Description": "sample string 2",
  "PercentTime": 64,
  "Created": "2025-02-16T01:08:37.273048+00:00",
  "CreatedBy": "1307f663-43fc-40bf-af05-cbf102b84813",
  "Updated": "2025-02-16T01:08:37.273048+00:00",
  "UpdatedBy": "08773041-748e-4943-b2bf-210808d5c516",
  "PerformanceIndicators": "sample string 3",
  "Deleted": true,
  "DeletedByRef": true
}