Travel Request v4 - Participant Resources

Manage participants and child requests attached to a Budget Request.

Get Participants for a Budget Request

This endpoint will enable you to retrieve the list of participants of a Budget Request, as well as the child Requests for each of the participants.

Scopes

travelrequest.write - Refer to Scope Usage for full details.

HTTP Request

URI Template
GET {datacenter}/travelrequest/v4/requests/{requestUuid}/participants

Parameters

Name Type Format Description
requestUuid string [RFC 4122] Required The unique identifier of the Request.
userId string - The unique identifier of the user getting the participants list. If empty when using a Company token the default system user will be assumed to perform the action.

Headers

concur-correlationid is a specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace.

Payload

None.

HTTP Response

HTTP Status Codes

To learn more about response HTTP status codes for this API see Travel Request v4 - HTTP Status Codes.

Payload

ParentRequestParticipant

Example - One participant with two Child Requests and One Participant without Child Request

HTTP Request

GET https://us.api.concursolutions.com/travelrequest/v4/requests/224AF3CDCC2A5244A37C72FA5770C6F2/participants
Accept: application/json
Authorization: Bearer {token}
Concur-CorrelationId: 5512c7be-3fab-4d65-ae69-8a74a04a0c7f

HTTP Response

200 OK

[
  {
    "participant": {
      "id": "60dea1fd-489f-48b9-925f-0d62a5b48175"
    },
    "requests": [
      {
        "href": "https://us.api.concursolutions.com/travelrequest/v4/requests/A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
        "id": "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4",
        "template": "https://us.api.concursolutions.com/travelrequest/v4/requests/{id}"
      },
      {
        "href": "https://us.api.concursolutions.com/travelrequest/v4/requests/B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5",
        "id": "B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5",
        "template": "https://us.api.concursolutions.com/travelrequest/v4/requests/{id}"
      },
    ]
  },
  {
    "participant": {
      "id": "72efb2ae-5a0e-59ca-b037-1e73b6c59286"
    }
  }
]

Manage Participants of a Budget Request

This endpoint will enable to manage participants (add or remove them) from a Budget Request.

Scopes

travelrequest.write - Refer to Scope Usage for full details.

HTTP Request

URI Template
PATCH {datacenter}/travelrequest/v4/requests/{requestUuid}/participants

Parameters

Name Type Format Description
requestUuid string [RFC 4122] Required The unique identifier of the Request.
userId string - The unique identifier of the user updating the participants list. Required when connecting with a Company token. If empty, a 400 missingRequiredParam error.

Headers

concur-correlationid is a specific custom header used for technical support in the form of a RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace.

Payload

Request Participants For Patch

HTTP Response

HTTP Status Codes

To learn more about response HTTP status codes for this API see Travel Request v4 - HTTP Status Codes.

Payload

None.

Example - adding and removing a participant to a Budget Request

HTTP Request

PATCH https://us.api.concursolutions.com/travelrequest/v4/requests/224AF3CDCC2A5244A37C72FA5770C6F2/participants
Content-Type: application/merge-patch+json
Accept: application/json
Authorization: Bearer {token}
Concur-CorrelationId: 5512c7be-3fab-4d65-ae69-8a74a04a0c7f

{
  "value": [
    {
      "id": "8422A66-A9B0-1424-5802-0D9BCD4351D3"
    },
    {
      "id": "9C33FBA0-ACB7-4F85-83BD-FC0DF3A78522",
      "@deleted": true
    }
  ]
}

HTTP Response

204 No Content

On this page