You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Request: GET /training/day/{dayId}

Permissions to Run the Request

Account OwnerAccount AdministratorsDepartment Administratorsor 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 OwnerAccount AdministratorDepartment Administrator, or a user with a role with custom settings. 
X-Auth-Password (required)The password of Account OwnerAccount AdministratorDepartment Administrator, or a user with a role with custom settings. 
ParameterDescription
dayId (required)The day ID you would like to get info on.

Response Parameters

Parameter

Description

dayId

The training day ID.
sessionIdThe session’s ID.
trainingIdThe training ID.
startTimeThe start date and time of the day according to time zone that was selected when the training was created.
location (optional)The training location.
url (optional)The link to the online meeting. For example, if integration with Zoom is enabled, you will see a link to a Zoom meeting.

Response Codes

Code

Text

Description

200OKThe request has been successfully processed. The response body will contain XML data with the information on the enrollment.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission DeniedThe user doesn't have enough permissions to get information on an enrollment.
404Day not foundThe day you requested could not be found.

Sample Request

GET /training/day/4728d47a-c96a-11ed-97ec-b6c48b3dc692
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: admin@company.ru
X-Auth-Password: password
Content-Type:application/xml

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <day>
       <dayId>cacce844-c969-11ed-a00b-0242ac16004e</dayId>
       <sessionId>cacce01a-c969-11ed-92d1-0242ac16004e</sessionId>
       <trainingId>c42d2094-c969-11ed-8b2e-0242ac16004e</trainingId>
       <startTime>2023-03-23T12:00:00+00:00</startTime>
   </day>
</response>
  • No labels