Read all basic roles for the currently logged in individual.
|
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>839b0eb2-621d-4c51-827d-f7dbd6373199</ID> <IndividualID>cd3d763d-0c54-42c0-8cf0-4c775f254a75</IndividualID> <Name>sample string 1</Name> <Rank>1</Rank> <Description>sample string 2</Description> <PercentTime>64</PercentTime> <Created>2026-11-21T09:31:37.6373545+00:00</Created> <CreatedBy>d9a3f92d-2711-48b7-8319-b6f0cdd383e5</CreatedBy> <Updated>2026-11-21T09:31:37.6373545+00:00</Updated> <UpdatedBy>8fc6b29f-b08e-4027-b7ac-db938a74d16b</UpdatedBy> <PerformanceIndicators>sample string 3</PerformanceIndicators> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> </BasicRole>
{
"ID": "839b0eb2-621d-4c51-827d-f7dbd6373199",
"IndividualID": "cd3d763d-0c54-42c0-8cf0-4c775f254a75",
"Name": "sample string 1",
"Rank": 1,
"Description": "sample string 2",
"PercentTime": 64,
"Created": "2026-11-21T09:31:37.6373545+00:00",
"CreatedBy": "d9a3f92d-2711-48b7-8319-b6f0cdd383e5",
"Updated": "2026-11-21T09:31:37.6373545+00:00",
"UpdatedBy": "8fc6b29f-b08e-4027-b7ac-db938a74d16b",
"PerformanceIndicators": "sample string 3",
"Deleted": true,
"DeletedByRef": true
}