Docs

Get Event Roles

GET /Events/{eventId}/roles

GET/Events/{eventId}/roles

Lists the event's role slots in the order the event type defines them, with each slot's name, section, whether it is filled by crew or by a collaborator, whether it holds one occupant or many, its occupants, its required and task tracking settings (each with whether this event overrides the type default), due date and tracking task status. Empty for an event without a type. Only slots the current type uses are returned. The slot ids it returns are the eventRoleId used by the other role operations.

Path Parameters

FieldTypeRequiredDescription
eventIduuidRequired

Response

Type: GetEventRoleResponse[]

GetEventRoleResponse

FieldTypeDescription
iduuid
requiredGetEventRoleResponseFlagState
taskTrackedGetEventRoleResponseFlagState
dueDateGetEventRoleResponseDueDateState
indexinteger
sectionIduuid| null
sectionNamestring| null
roleGetEventRoleResponseRoleDefinitionInfo
occupantsGetEventRoleResponseOccupantInfo[]| null
taskIduuid| null
taskStatusstring| null

GetEventRoleResponseFlagState

FieldTypeDescription
effectiveboolean
isOverriddenboolean

GetEventRoleResponseDueDateState

FieldTypeDescription
effectivedate-time| null
isOverriddenboolean

GetEventRoleResponseRoleDefinitionInfo

FieldTypeDescription
iduuid
namestring| null
fillerKindstring| null
cardinalitystring| null
availabilityGetEventRoleResponseAvailabilityInfo

GetEventRoleResponseOccupantInfo

FieldTypeDescription
iduuid
crewIduuid| null
collaboratorIduuid| null

GetEventRoleResponseAvailabilityInfo

FieldTypeDescription
recordIdsuuid[]| null