POST api/LMS.Courses/DefaultAction

POST api/LMS/Courses/DefaultAction LMS All Services

This service creates the new course and returns the courseID value if successful. (Note: If the course code 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 set the Course Code, Title, and Effective Date fields.

Define this parameter in the request body.

CourseDTO

CourseDTO:

PropertyName	Type	Required	Description
CourseCode	String	Mandatory	Maximum length: 50 chars
CourseTitle	String	Conditional	Maximum length: 100 chars
EffectiveDate	DateTime	Conditional
ExpiryDate	Nullable<DateTime>	Optional
IsPublished	Boolean	Optional
Creator	String	Optional	Maximum length: 50 chars
EstimatedHours	Single	Optional
ForceCompletion	Boolean	Optional
TotalLessons	Int32	Optional
TotalBlocks	Int32	Optional

Request body formats

application/json, text/json

Sample:

{
  "CourseCode": "sample string 1",
  "CourseTitle": "sample string 2",
  "EffectiveDate": "2025-05-11T14:23:08.5908616+00:00",
  "ExpiryDate": "2025-05-11T14:23:08.5908616+00:00",
  "IsPublished": true,
  "Creator": "sample string 5",
  "EstimatedHours": 6.1,
  "ForceCompletion": true,
  "TotalLessons": 8,
  "TotalBlocks": 9
}

application/xml, text/xml

Sample:

<CourseDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CourseCode>sample string 1</CourseCode>
  <CourseTitle>sample string 2</CourseTitle>
  <EffectiveDate>2025-05-11T14:23:08.5908616+00:00</EffectiveDate>
  <ExpiryDate>2025-05-11T14:23:08.5908616+00:00</ExpiryDate>
  <IsPublished>true</IsPublished>
  <Creator>sample string 5</Creator>
  <EstimatedHours>6.1</EstimatedHours>
  <ForceCompletion>true</ForceCompletion>
  <TotalLessons>8</TotalLessons>
  <TotalBlocks>9</TotalBlocks>
</CourseDTO>

Return Type

Return type	Int32

Response Information

Response body formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int>1</int>