POST /api/v1/paths/{pathId}/sessions/
Create a path session for the provided path.
Dates must be provided as ISO 8601 complete date plus hours, minutes and seconds. See w3c standards for further details.
RETURNS
- id of the session created
BODY
The following properties must be provided in the Body, formatted as raw/JSON.
| Name | Required/Optional | Description |
|---|---|---|
sessionName | Required | Name of the session. |
startDate | Required | Start date of the session, expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z. |
endDate | Optional | End date of the session, expressed in ISO 8601 format — example: 2022-05-16T22:00:00.000Z. |
instructorsMails | Optional | Array of email addresses belonging to the instructors for this session, with the main instructor as the first item of the array. If this property is provided, it cannot be null. If this property is not provided, or if the provided array is empty, the platform owner will be added as the session instructor.. |
sessionOwnerGroup | Required | ID of the group owning the session. |
sessionAdditionalInformation | Optional | Additional information about the session: registration number, ID in another tool, etc. It will be available in the CSV exports and through the API, but will not be displayed elsewhere. |
ERRORS
| Status code | Error body | Reason |
|---|---|---|
404 | { "error": "path_not_found" } | if the path Id doesn't belong to the company |
404 | { "error": "path_not_found" } | if no path Id has been provided |
404 | { "error": "path_not_found" } | if the provided path ID is not valid |
400 | { "error": "invalid_session_name" } | if the provided session name is null or empty |
400 | { "error": "invalid_start_date" } | if the provided start date is not valid, or null or empty |
400 | { "error": "invalid_end_date" } | if the provided end date is not valid |
400 | { "error": "invalid_session_owner_group" } | if the provided session owner group is not valid, or null or empty |
400 | { "error": "session_owner_group_not_found" } | if the provided session owner group does not exist |
400 | { "error": "invalid_instructors" } | if the provided instructorsMails is null or empty or does not contain any items |
400 | { "error": "invalid_instructors" } | if the provided instructors mails is not a valid email |
400 | { "error": "instructors"_not_found } | if one of the provided instructors mails does not belong to the company |
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
pathId |
String | Yes |
The ID of the path |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
sessionName |
String | No | |
sessionAdditionalInformation |
String | No | |
endDate |
String | No | |
sessionOwnerGroup |
String | No | |
startDate |
String | No | |
instructorsMails[] |
Array | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.