Request Information

URI Parameters

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

Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.

Body Parameters

None.

Response Information

Resource Description (BasicRole)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
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.

Response Formats

application/xml, text/xml

Sample
<BasicRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>0fa4919d-da40-4ca4-8931-7aaf27dd730a</ID>
  <IndividualID>a79e4294-b7c5-4f09-9326-460531a6ff9c</IndividualID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <Description>sample string 2</Description>
  <PercentTime>64</PercentTime>
  <Created>2021-11-03T18:44:56.7427247+00:00</Created>
  <CreatedBy>2c15b201-f997-4808-8002-15fb325ea055</CreatedBy>
  <Updated>2021-11-03T18:44:56.7427247+00:00</Updated>
  <UpdatedBy>94e56ebe-895d-41be-8302-2dc949617a75</UpdatedBy>
  <PerformanceIndicators>sample string 3</PerformanceIndicators>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</BasicRole>

application/json, text/json

Sample
{
  "ID": "0fa4919d-da40-4ca4-8931-7aaf27dd730a",
  "IndividualID": "a79e4294-b7c5-4f09-9326-460531a6ff9c",
  "Name": "sample string 1",
  "Rank": 1,
  "Description": "sample string 2",
  "PercentTime": 64,
  "Created": "2021-11-03T18:44:56.7427247+00:00",
  "CreatedBy": "2c15b201-f997-4808-8002-15fb325ea055",
  "Updated": "2021-11-03T18:44:56.7427247+00:00",
  "UpdatedBy": "94e56ebe-895d-41be-8302-2dc949617a75",
  "PerformanceIndicators": "sample string 3",
  "Deleted": true,
  "DeletedByRef": true
}