regis

<back to all web services

CourseCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/Create
import Foundation
import ServiceStack

public class CourseCreateRequest : Codable
{
    public var course_name:String
    public var title:String
    public var pretty_title:String
    public var course_description:String
    public var is_active:Bool
    public var course_requirements:[CourseRequirementResponse] = []
    public var authorizing_uuid:String

    required public init(){}
}

public class CourseRequirementResponse : Codable
{
    public var course_id:Int
    public var required_course_id:Int
    public var requirement_group:Int
    public var is_prerequisite:Bool
    public var is_corequisite:Bool
    public var timestamp:Date

    required public init(){}
}


Swift CourseCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Courses/Admin/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourseCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <course_requirements xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
    <d2p1:CourseRequirementResponse>
      <d2p1:course_id>0</d2p1:course_id>
      <d2p1:is_corequisite>false</d2p1:is_corequisite>
      <d2p1:is_prerequisite>false</d2p1:is_prerequisite>
      <d2p1:required_course_id>0</d2p1:required_course_id>
      <d2p1:requirement_group>0</d2p1:requirement_group>
      <d2p1:timestamp>0001-01-01T00:00:00</d2p1:timestamp>
    </d2p1:CourseRequirementResponse>
  </course_requirements>
  <is_active>false</is_active>
  <pretty_title>String</pretty_title>
  <title>String</title>
</CourseCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>