Participant

Participants Participant
Methods Supported:

  • GET – read participant entities

  • POST – create participant entity

  • PATCH – update participant entity (some properties read only)

  • DELETE – delete participant entity, deletes the user from the system entirely

Filters supported:

  • ID – primary key

  • Name – filtering by participant name

Expansions supported:

  • Groups – the collection of groups this participant is a member of

The Participants feed contains data about users that have the special Participant role.

EntityType: Participant
Password Edm.String

The Participant’s password. This field is not available during a GET operation and will always appear to be set to null but it can provided when creating (POST) or updating (PATCH) a Participant record.

Added in version 2021.02.

Entity Key: ID Edm.Int32 NOT NULL

The numeric ID of the Participant.

Name Edm.String

The name of the Participant. See G_Participant.Participant_Name.

FirstName Edm.String

The first name of the Participant. See G_Participant.First_Name.

LastName Edm.String

The last name of the Participant. See G_Participant.Last_Name.

MiddleName Edm.String

The middle name of the Participant. See G_Participant.Middle_Name.

PrimaryAddress1 Edm.String
PrimaryAddress2 Edm.String
PrimaryCity Edm.String
PrimaryState Edm.String
PrimaryZIPCode Edm.String
PrimaryCountry Edm.String
PrimaryPhone Edm.String
PrimaryFax Edm.String
PrimaryEmail Edm.String
SecondaryAddress1 Edm.String
SecondaryAddress2 Edm.String
SecondaryCity Edm.String
SecondaryState Edm.String
SecondaryZIPCode Edm.String
SecondaryCountry Edm.String
SecondaryPhone Edm.String
SecondaryFax Edm.String
SecondaryEmail Edm.String
Salutation Edm.String
OrganizationName Edm.String
Department Edm.String
Title Edm.String
AssistantName Edm.String
ManagerName Edm.String
Gender Edm.String
URL Edm.String
Details Edm.String

The details field. See G_Participant.Details. Often used to contain a human-friendly representation of the participant’s full name.

Details1 Edm.String
Details2 Edm.String
Details3 Edm.String
Details4 Edm.String
Details5 Edm.String
Details6 Edm.String
Details7 Edm.String
Details8 Edm.String
Details9 Edm.String
Details10 Edm.String
Details11 Edm.String
Details12 Edm.String
Details13 Edm.String
Details14 Edm.String
Details15 Edm.String
Details16 Edm.String
Details17 Edm.String
Details18 Edm.String
Details19 Edm.String
Details20 Edm.String
DateOfBirth Edm.String

Added in version 2021.08.

The optional date of birth of the participant.

PreferredLang Edm.String

The preferred language of the participant. This is specified using ISO two-letter language codes with additional region qualification through the use of 2-letter country codes, e.g, en-US for English as spoken in the United States.

PreferredTimezone Edm.String

The preferred timezone of the participant. Reserved for future use.

Added in version 2021.05.

SsoId Edm.String

Added in version 2021.02.

The unique identifier used by the external identity provider to identify the participant.

RegistrationDateTime Edm.DateTime NOT NULL

The date and time when the participant was first registered. Sourced from G_Participant.Date_Registration but converted to UTC.

Groups Group Collection

Navigation property to the Groups this participant is a member of.

Schedules Schedule Collection

Navigation property to the Schedules related to this participant

action CheckPassword (Password Edm.String) Edm.Boolean

Added in version 2021.05.

Returns True if the input parameter matches the password set for this participant and False otherwise.

action SendWelcomeEmail () Edm.Null

Added in version 2021.05.

Generates the standard Welcome email for the participant. A participant created through this API does not automatically get an email notification of their new account so this action must be used if a notification is required. It can be called at any time to resend the message.

action ActionableSchedules () ActionableSchedule Collection

Returns a collection of ActionableSchedule related to this participant. It takes no parameters and is bound to a specific Participant so is called like this:

POST /deliveryodata/<customer-id>/Participant(123456)/ActionableSchedules

{
}

A Schedule is actionable if the Participant can take some action in relation to it (typically start or resume). If there are no actionable schedules an empty value is returned as follows:

Content-Type: application/json; charset=utf-8

{
    "odata.metadata": "https://ondemand.questionmark.eu/deliveryodata/<customer-id>/$metadata#Collection(QM.DeliveryODataService.DTO.ActionableSchedule)",
    "value": []
}

Warning

as of the 2022.03 release, a new optional parameter ShowHidden will be supported that will default to False. Currently, all schedules are returned by default but in future you must pass ShowHidden as True if you want hidden schedules to be returned by this call. To determine if a hidden schedule is actionable for a Participant it is recommended to use ActionableSchedule passing the ScheduleID explicitly as to avoid returning hidden Schedules that apply to all Participants.

action ActionableSchedule (ScheduleID Edm.Int32) ActionableSchedule

Returns a single ActionableSchedule related to this participant and the Schedule referred to in the input parameter.

It is called like this:

POST /deliveryodata/<customer-id>/Participant(123456)/ActionableSchedule

{
    "ScheduleID": 12345
}

If there are no actions available then 404 status code is returned.

See ActionableSchedules for more information.

Warning

as of the 2021.05 release, if a participant has an exception schedule and the parent schedule ID is passed to this action then the exception schedule is evaluated instead. As a result, the returned ActionableSchedule may have a different ID from the passed parameter value.