POST api/LMS.Enrollments/EnrollByUserGroup?UserGroup={UserGroup}&CourseCode={CourseCode}&StartDate={StartDate}&EndDate={EndDate}

POST api/LMS/Enrollments/EnrollByUserGroup?UserGroup={UserGroup}&CourseCode={CourseCode}&StartDate={StartDate}&EndDate={EndDate} LMS All Services

This service creates multiple new enrollments in the course for all the users that belong to the passed in user group and returns the enrollmentID list (enrollmentID > 0 is successful, otherwise enrollmentID = 0). All Dates must be passed in are assumed to be in UTC. (Note: If the enrollment already exists no creation will take place but the StartDate and ExpiryDate will be overwritten.)

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
UserGroup	max 200 characters	Define this parameter in the request URI.	String

CourseCode	max 50 characters	Define this parameter in the request URI.	String

StartDate	DateTime Optional (defaults to call DateTime in UTC if none sent)	Define this parameter in the request URI.	Nullable<DateTime>

EndDate	DateTime Optional (defaults to 60 days after start date if none sent)	Define this parameter in the request URI.	Nullable<DateTime>

Return Type

Return type	Int32[]

Response Information

Response body formats

application/json, text/json

Sample:

[
  1,
  2,
  3
]

application/xml, text/xml

Sample:

<ArrayOfInt xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <int>1</int>
  <int>2</int>
  <int>3</int>
</ArrayOfInt>