Getting Session Info Using Session ID
AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: GET /training/session/{session_id}
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles that permit a training to be viewed.
Request Headers
Header | Description |
---|---|
X-Auth-Account-Url (required) | The base URL of the account, e.g. https://myaccount.ispringlearn.com. |
X-Auth-Email (required) | The login of Account Owner, Account Administrator, Department Administrator, or a user with a role with custom settings. |
X-Auth-Password (required) | The password of Account Owner, Account Administrator, Department Administrator, or a user with a role with custom settings. |
Parameter | Description |
session_id (required) | The session ID you would like to get info on. |
Response Parameters
Parameter | Description |
---|---|
trainingSession | An array with the training’s data. |
id | The session’s ID. |
title | The session’s title. |
startTime | The date and time the session started. |
duration | The session’s duration in seconds. |
dayIds[] | An array with session’s day data. |
instructor (optional) | The first and last name of the session’s instructor. |
Response Codes
Code | Text | Description |
---|---|---|
200 | OK | The request has been successfully processed. The response body will contain XML data with the information on the enrollment. |
400 | Bad Request | A request error. |
401 | Unauthorized | An authorization error. |
403 | Permission Denied | The user doesn't have enough permissions to get information on an enrollment. |
404 | Session not found | The session you requested could not be found. |
Sample Request
GET /training/session/b437976a-2d14-11ed-9e57-0242c0a87043
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://company.ispringlearn.com
X-Auth-Email: admin@company.com
X-Auth-Password: password
XML
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<response>
<trainingSession>
<id>4728d100-c96a-11ed-a664-b6c48b3dc692</id>
<title>Сессия 1</title>
<startTime>2023-03-31T15:30:00-07:00</startTime>
<duration>7200</duration>
<dayIds>
<id>4728d47a-c96a-11ed-97ec-b6c48b3dc692</id>
<id>bfb8a744-d838-11ed-9199-9af23e8ed4b1</id>
</dayIds>
</trainingSession>
<trainingSession>
<id>0b0de6ac-d841-11ed-bc77-9af23e8ed4b1</id>
<title>Сессия 2</title>
<startTime>2023-04-11T12:30:00+03:00</startTime>
<duration>3600</duration>
<instructor>Nick Moore</instructor>
<dayIds>
<id>0b0dec6a-d841-11ed-b90c-9af23e8ed4b1</id>
</dayIds>
</trainingSession>
</response>
XML