Create a new participant

1min

POST
Asynchronous API for creating a new participant of participant type specified by participantTypePluralName.
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.
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-ORIGIN-TOKEN
string
*
App requesting for the attributes.
X-COREOS-CALLBACK-SECRET
string
callback scret token
BODY PARAMETERS
body
ParticipantCreateRequest
*
Create new participant
uniqueCode
string
*
Unique code for identifying the participant
name
string
Name of the participant
owner
string
*
The ID of the Participant to whom this Participant belongs. For a Vehicle owned by an Operator, it will be the Operator ID. For a Client, it will be the Tenant ID. For a Tenant, it will be the Participant ID of the Tenant itself.
properties
object
*
Key-Value representation of all custom attributes of the participant.
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
*
﻿
﻿

Updated 24 Aug 2023

Did this page help you?

API to get list of orphan reasons codes (not associated with any reason code).

Get list of participants of a participant type.