regis

<back to all web services

CoursesAdminRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/{level}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CoursesAdminRequest
    {
        public String level = null;
        
        public String getLevel() { return level; }
        public CoursesAdminRequest setLevel(String value) { this.level = value; return this; }
    }

    public static class CoursesAdminResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<CourseResponse> courses = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CoursesAdminResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<CourseResponse> getCourses() { return courses; }
        public CoursesAdminResponse setCourses(ArrayList<CourseResponse> value) { this.courses = value; return this; }
    }

    public static class CourseResponse
    {
        public Integer id = null;
        public String course_name = null;
        public String title = null;
        public String pretty_title = null;
        public String course_description = null;
        public Boolean is_active = null;
        public Date added_date = null;
        public String added_by = null;
        public Date changed_date = null;
        public String changed_by = null;
        public Date timestamp = null;
        
        public Integer getId() { return id; }
        public CourseResponse setId(Integer value) { this.id = value; return this; }
        public String getCourseName() { return course_name; }
        public CourseResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getTitle() { return title; }
        public CourseResponse setTitle(String value) { this.title = value; return this; }
        public String getPrettyTitle() { return pretty_title; }
        public CourseResponse setPrettyTitle(String value) { this.pretty_title = value; return this; }
        public String getCourseDescription() { return course_description; }
        public CourseResponse setCourseDescription(String value) { this.course_description = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public CourseResponse setIsActive(Boolean value) { this.is_active = value; return this; }
        public Date getAddedDate() { return added_date; }
        public CourseResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getAddedBy() { return added_by; }
        public CourseResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public CourseResponse setChangedDate(Date value) { this.changed_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public CourseResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getTimestamp() { return timestamp; }
        public CourseResponse setTimestamp(Date value) { this.timestamp = value; return this; }
    }

}

Java CoursesAdminRequest 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/{level} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoursesAdminRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <level>String</level>
</CoursesAdminRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoursesAdminResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <courses>
    <CourseResponse>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <course_description>String</course_description>
      <course_name>String</course_name>
      <id>0</id>
      <is_active>false</is_active>
      <pretty_title>String</pretty_title>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <title>String</title>
    </CourseResponse>
  </courses>
</CoursesAdminResponse>