Participant Service
Participant State
Transition the current state of the participant.
1min
PUT
PATH PARAMETERS
participantTypePluralName
ParticipantTypePluralName
*A unique *plural name* i.e. a term that defines multiple participants of this participant type. This is used as collection name in resource URL for this participant type and as participant id prefix.
participantId
UniqueId
*Unique ID. Unique Identifier of object.
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*Unique requestId
X-COREOS-TID
string
*Tenant id
X-COREOS-ACCESS
string
*Unique core-os access token
X-COREOS-USERINFO
string
core-os user info
X-COREOS-CALLBACK-SECRET
string
callback scret token
BODY PARAMETERS
body
ParticipantStateUpdateRequest
*Event for participant state transition.
eventCode
EventCode
*Event Code of the format:E-yyy. E - Prefix indicating that this is an event code. yyy - 3 digit event code string ranging from 001 to 999
reasonCode
ReasonCode
Reason Code of the format:R-nnnn R - Prefix indicating that this is a reason code nnnn - 4 digit reason code string ranging from 0001 to 9999
timestamp
EpochTimestamp
*Represents a date time as number of seconds elapsed since 00:00Hrs of 1st January 1970 UTC.
data
object
*source
EventSource
*callback
CallbackForInstance
Callback for operations sends status success/failed.
RESPONSES
202
OK - The request Accepted.
SuccessResponseId
data
IdResponse
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*Error Information
request
Request
*401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*Error Information
request
Request
*404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*Error Information
request
Request
*

Updated 24 Aug 2023
Did this page help you?