36360learning
Paths

Create a path session

Changed on

🔑

Required OAuth scope: paths:write.

Creates a path session for the given path.

post/api/v2/paths/{pathId}/sessions

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/paths/{pathId}/sessions
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Path parameters

pathIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the path.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

mainInstructorIdstring ObjectId required

The unique ID of the main instructor of the path session.

startDatestring date-time required

The date and time when the path session starts, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

endDatestring date-time

The date and time when the path session ends, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

userLimitinteger

The maximum number of learners that can self enroll in the path session.

registrationRequestValidation'disabled' | 'instructors' | 'managers' | 'adminsAndManagers' | 'adminsCoachesInstructorsManagers'

DEPRECATED — Use registrationRequestSetting instead. Ignored when registrationRequestSetting is provided. Only applies to enrollment requests. The registration request validation options for open access registrations. Options are:

  • disabled: There is no validation for registration.
  • instructors: The instructors validate the registration request.
  • managers: The managers validate the registration request.
  • adminsAndManagers: The managers and group admin validate the registration request.
  • adminsCoachesInstructorsManagers:Managers, instructors, group admins and coaches validate the registration request.
namestring required

The title of the path session.

additionalInformationstring

The additional information of the path session.

instructorIdsstring[]

The list of unique IDs of the co-instructors of the path session.

Example request

{
  "mainInstructorId": "507f1f77bcf86cd799439011",
  "automaticReenrollment": {
    "delayDays": 90
  },
  "name": "Employee Onboarding October Session.",
  "additionalInformation": "A0015221",
  "instructorIds": [
    "507f1f77bcf86cd799439011"
  ]
}

Response

Returns the information about the created session.

mainInstructorIdstring ObjectId required

The unique ID of the main instructor of the path session.

startDatestring date-time required

The date and time when the path session starts, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

endDatestring date-time

The date and time when the path session ends, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

userLimitinteger

The maximum number of learners that can self enroll in the path session.

_idstring ObjectId required

The unique ID of the path session.

createdAtstring date-time required

The date and time when the path session was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

groupIdstring ObjectId required

The unique ID of the path session owner group.

instructorIdsstring[] required

The list of unique IDs of the co-instructors of the path session.

isAudienceBuilderboolean required

True if the path session is an audience builder session; false otherwise.

modifiedAtstring date-time required

The date and time when the path session was last updated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

namestring required

The title of the path session.

pathIdstring ObjectId required

The unique ID of the path the session belongs to.

registrationRequestValidation'disabled' | 'instructors' | 'managers' | 'adminsAndManagers' | 'adminsCoachesInstructorsManagers' required

DEPRECATED — Use registrationRequestSetting instead. Only applies to enrollment requests. The registration request validation options for open access registrations. Options are:

  • disabled: There is no validation for registration.
  • instructors: The instructors validate the registration request.
  • managers: The managers validate the registration request.
  • adminsAndManagers: The managers and group admin validate the registration request.
  • adminsCoachesInstructorsManagers:Managers, instructors, group admins and coaches validate the registration request.
additionalInformationstring

The additional information of the path session.

rootSessionIdstring ObjectId

The unique ID of the root session.

Example response

{
  "mainInstructorId": "507f1f77bcf86cd799439011",
  "automaticReenrollment": {
    "delayDays": 90
  },
  "_id": "507f1f77bcf86cd799439011",
  "groupId": "507f1f77bcf86cd799439011",
  "instructorIds": [
    "507f1f77bcf86cd799439011"
  ],
  "name": "Employee Onboarding October Session.",
  "pathId": "507f1f77bcf86cd799439011",
  "additionalInformation": "A0015221",
  "rootSessionId": "507f1f77bcf86cd799439011",
  "translations": [
    {
      "lang": "fr",
      "translatorIds": [
        "507f1f77bcf86cd799439011"
      ],
      "translatedFields": {
        "name": "Accueil des employés Session d'Octobre"
      }
    }
  ]
}

Changes

  • d827a4a84180Revision changes
    • breaking

      added subschema #5: Registration Request Assessors Missing subschema #6: Registration Request Assessors Not Allowed subschema #7: Registration Request Configuration Missing subschema #9: Unenrollment Request Feature Disabled to the response body oneOf list for the response status

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      request property deprecated

    • info

      response property registrationRequestValidation deprecated

    • info

      added the required property to the response with the status