regis

<back to all web services

CoursesAdminRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/{level}

export class CourseResponse
{
    public id?: number;
    public course_name: string;
    public title: string;
    public pretty_title: string;
    public course_description: string;
    public is_active: boolean;
    public added_date?: string;
    public added_by: string;
    public changed_date?: string;
    public changed_by: string;
    public timestamp: string;

    public constructor(init?: Partial<CourseResponse>) { (Object as any).assign(this, init); }
}

export class CoursesAdminResponse
{
    public responseStatus: ResponseStatus;
    public courses: CourseResponse[];

    public constructor(init?: Partial<CoursesAdminResponse>) { (Object as any).assign(this, init); }
}

export class CoursesAdminRequest
{
    public level: string;

    public constructor(init?: Partial<CoursesAdminRequest>) { (Object as any).assign(this, init); }
}

TypeScript CoursesAdminRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"level":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"courses":[{"id":0,"course_name":"String","title":"String","pretty_title":"String","course_description":"String","is_active":false,"added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}]}