Read an individual's basic roles.
individualid
globally unique identifier
Required
Guid ID of the individual whose basic roles are to be read. |
deleted
byte
Add ?deleted=0, 1, or 2 for not deleted, deleted, or all. |
None.
ID
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.) |
Name
string
Required
Name of the given basic role. (Max length 255 characters) |
Rank
integer
Rank of the given basic role. |
Description
string
Description of the given basic role. |
PercentTime
byte
Percent of time that should be devoted to the given basic role. |
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. |
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. |
PerformanceIndicators
string
ReadOnly
Performance indicators that are linked to the given basic role. |
Deleted
boolean
ReadOnly
Deleted status of the given basic role. |
DeletedByRef
boolean
ReadOnly
Deleted by Reference status of the given basic role. |
<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>8ec11a05-6240-4865-8dbc-f77ca3e341ca</ID> <IndividualID>4f3fb563-269a-44af-af49-7da1a2b69b55</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2024-10-23T12:56:10.4351701+00:00</Created> <CreatedBy>c41464dc-4841-475a-9a8f-58a11158f222</CreatedBy> <Updated>2024-10-23T12:56:10.4351701+00:00</Updated> <UpdatedBy>2190f309-0951-4788-a731-ad12c4f91f95</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{ "ID": "8ec11a05-6240-4865-8dbc-f77ca3e341ca", "IndividualID": "4f3fb563-269a-44af-af49-7da1a2b69b55", "Name": "sample string 1", "Rank": 1, "Description": "sample string 2", "PercentTime": 64, "Created": "2024-10-23T12:56:10.4351701+00:00", "CreatedBy": "c41464dc-4841-475a-9a8f-58a11158f222", "Updated": "2024-10-23T12:56:10.4351701+00:00", "UpdatedBy": "2190f309-0951-4788-a731-ad12c4f91f95", "PerformanceIndicators": "sample string 3", "Deleted": true, "DeletedByRef": true }