POST api/LMS.Enrollments/DefaultAction

POST api/LMS/Enrollments/DefaultAction LMS All Services

This service creates a new enrollment and returns the enrollmentID if successful. (Note: If the login name and course code pair already exists no creation will take place.)

Request Information

Headers

Fields	Type	M/O/C	Definition
AccountLoginName	String(50)	Mandatory	Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword	String(50)	Mandatory	Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID	String(50)	Mandatory	Name or ID of application or system that initiated the call.
DomainID	String(50)	Mandatory	Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept	String	Optional	Format in which client expects the response: [application/json] (default), [application/xml]
ContentType	String	Optional	Format in which client is sending the request: [application/json] (default), [application/xml]

Parameters

Name

Description

Additional information

Type

model

Must send Login Name, Course Code, Start Date, and Expiry Date

Define this parameter in the request body.

EnrollmentDTO

EnrollmentDTO:

PropertyName	Type	Required	Description
EnrollmentID	Int32	Display
LoginName	String	Mandatory	Maximum length: 50 chars
CourseCode	String	Mandatory	Maximum length: 50 chars
StartDate	DateTime	Conditional
ExpiryDate	Nullable<DateTime>	Conditional
LastLaunched	Nullable<Int32>	Optional
Instructor	String	Optional
ReservationNumber	String	Optional	For modification operation,to remove the value of reservation number, pass an empty string.Passing null value or missing reservation number in request body will let the reservation keep its previous value.

Request body formats

application/json, text/json

Sample:

{
  "EnrollmentID": 1,
  "LoginName": "sample string 2",
  "CourseCode": "sample string 3",
  "StartDate": "2025-05-11T15:00:55.5504136+00:00",
  "ExpiryDate": "2025-05-11T15:00:55.5504136+00:00",
  "LastLaunched": 1,
  "Instructor": "sample string 5",
  "ReservationNumber": "sample string 6"
}

application/xml, text/xml

Sample:

<EnrollmentDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <EnrollmentID>1</EnrollmentID>
  <LoginName>sample string 2</LoginName>
  <CourseCode>sample string 3</CourseCode>
  <StartDate>2025-05-11T15:00:55.5504136+00:00</StartDate>
  <ExpiryDate>2025-05-11T15:00:55.5504136+00:00</ExpiryDate>
  <LastLaunched>1</LastLaunched>
  <Instructor>sample string 5</Instructor>
  <ReservationNumber>sample string 6</ReservationNumber>
</EnrollmentDTO>

Return Type

Return type	Int32

Response Information

Response body formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int>1</int>