Getting Session Info Using Session ID
AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: getTrainingSession
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles that permit a training to be viewed.
Parameters
Parameter | Type | Description |
---|---|---|
token (required) | string | Access token. You can obtain a token by making a request. |
trainingSessionId (required) | string | The session ID you would like to get info on. |
Return Value
After the request has been successfully processed, the system returns an object with the following properties:
Parameter | Type | Description |
---|---|---|
trainingSession | array | An array with a session’s data. |
id | string | The session’s ID. |
title | string | The session’s title. |
startTime | string | The date and time the session started. |
duration | string | The session’s duration in seconds. |
dayIds[] | array | An array with session’s day data. |
instructor (optional) | string | The first and last name of the session’s instructor. |
Possible Errors
Error | Description |
---|---|
Permission denied | The user has no permissions to delete enrollments. |
Wrong parameters | The enrollment with the given ID hasn't been found. |
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:GetTrainingSessionRequest>
<soap:credentials>
<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
</soap:credentials>
<soap:trainingSessionId>b437976a-2d14-11ed-9e57-0242c0a87043</soap:trainingSessionId>
</soap:GetTrainingSessionRequest>
</soapenv:Body>
</soapenv:Envelope>
XML
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:ListSessionsByTrainingResult>
<ns1:trainingSession>
<ns1:id>4728d100-c96a-11ed-a664-b6c48b3dc692</ns1:id>
<ns1:title>Сессия 1</ns1:title>
<ns1:startTime>2023-03-31T15:30:00-07:00</ns1:startTime>
<ns1:duration>7200</ns1:duration>
<ns1:instructor xsi:nil="true"/>
<ns1:dayIds>
<ns1:id>4728d47a-c96a-11ed-97ec-b6c48b3dc692</ns1:id>
<ns1:id>bfb8a744-d838-11ed-9199-9af23e8ed4b1</ns1:id>
</ns1:dayIds>
</ns1:trainingSession>
<ns1:trainingSession>
<ns1:id>0b0de6ac-d841-11ed-bc77-9af23e8ed4b1</ns1:id>
<ns1:title>Сессия 2</ns1:title>
<ns1:startTime>2023-04-11T12:30:00+03:00</ns1:startTime>
<ns1:duration>3600</ns1:duration>
<ns1:instructor>Nick Moore</ns1:instructor>
<ns1:dayIds>
<ns1:id>0b0dec6a-d841-11ed-b90c-9af23e8ed4b1</ns1:id>
</ns1:dayIds>
</ns1:trainingSession>
</ns1:ListSessionsByTrainingResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML