regis

<back to all web services

SectionRequest

Requires Authentication
Required permission:ReadSections
The following routes are available for this service:
POST/Section/{uuid}
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type InstructorResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val regent_login:String = null with get,set
        member val preferred_name:String = null with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val full_name:String = null with get,set
        member val email:String = null with get,set
        member val image_base64:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentResponse() = 
        member val code:String = null with get,set
        member val document_name:String = null with get,set
        member val document_description:String = null with get,set

    [<AllowNullLiteral>]
    type SectionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val secUUID:String = null with get,set
        member val course_name:String = null with get,set
        member val section_code:String = null with get,set
        member val course_title:String = null with get,set
        member val course_short_title:String = null with get,set
        member val course_description:String = null with get,set
        member val crosslist_description:String = null with get,set
        member val crosslist_course_name:String = null with get,set
        member val location_long_name:String = null with get,set
        member val room:String = null with get,set
        member val instructors:ResizeArray<InstructorResponse> = new ResizeArray<InstructorResponse>() with get,set
        member val required_documents:ResizeArray<DocumentResponse> = new ResizeArray<DocumentResponse>() with get,set
        member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val first_meeting_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_meeting_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val meeting_days:String = null with get,set
        member val start_times:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val end_times:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val is_online_only:Boolean = new Boolean() with get,set
        member val is_weekend:Boolean = new Boolean() with get,set
        member val is_weekday:Boolean = new Boolean() with get,set
        member val is_evening:Boolean = new Boolean() with get,set
        member val is_waitlist:Boolean = new Boolean() with get,set
        member val has_special_requirements:Boolean = new Boolean() with get,set
        member val special_requirements:String = null with get,set
        member val is_unlisted:Boolean = new Boolean() with get,set
        member val credit_amounts:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
        member val audit_amounts:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
        member val audits_short_name:String = null with get,set
        member val audits_long_name:String = null with get,set
        member val credits_short_name:String = null with get,set
        member val credits_long_name:String = null with get,set
        member val distance_ed_materials:String = null with get,set
        member val prerequisites:String = null with get,set
        member val corequisites:String = null with get,set
        member val capacity:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val flat_fee_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val additional_fee_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val registered_students:Int32 = new Int32() with get,set
        member val three_credit_plus:Int32 = new Int32() with get,set
        member val two_credit:Int32 = new Int32() with get,set
        member val one_credit:Int32 = new Int32() with get,set
        member val three_audit_plus:Int32 = new Int32() with get,set
        member val two_audit:Int32 = new Int32() with get,set
        member val one_audit:Int32 = new Int32() with get,set
        member val crosslist_registered_students:Int32 = new Int32() with get,set
        member val grades_received:Int32 = new Int32() with get,set
        member val crosslist_grades_received:Int32 = new Int32() with get,set
        member val registration_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val registration_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val add_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val add_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val drop_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val drop_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val grading_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val term:String = null with get,set
        member val reporting_term:String = null with get,set
        member val reporting_year:Int32 = new Int32() with get,set
        member val current_status:String = null with get,set
        member val added_by:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type SectionRequest() = 
        member val uuid:String = null with get,set

F# SectionRequest 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 /Section/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"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"}},"secUUID":"String","course_name":"String","section_code":"String","course_title":"String","course_short_title":"String","course_description":"String","crosslist_description":"String","crosslist_course_name":"String","location_long_name":"String","room":"String","instructors":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"regent_login":"String","preferred_name":"String","first_name":"String","last_name":"String","full_name":"String","email":"String","image_base64":"String"}],"required_documents":[{"code":"String","document_name":"String","document_description":"String"}],"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","first_meeting_date":"0001-01-01T00:00:00.0000000","last_meeting_date":"0001-01-01T00:00:00.0000000","meeting_days":"String","start_times":["String"],"end_times":["String"],"is_online_only":false,"is_weekend":false,"is_weekday":false,"is_evening":false,"is_waitlist":false,"has_special_requirements":false,"special_requirements":"String","is_unlisted":false,"credit_amounts":[0],"audit_amounts":[0],"audits_short_name":"String","audits_long_name":"String","credits_short_name":"String","credits_long_name":"String","distance_ed_materials":"String","prerequisites":"String","corequisites":"String","capacity":0,"flat_fee_amount":0,"additional_fee_amount":0,"registered_students":0,"three_credit_plus":0,"two_credit":0,"one_credit":0,"three_audit_plus":0,"two_audit":0,"one_audit":0,"crosslist_registered_students":0,"grades_received":0,"crosslist_grades_received":0,"registration_start_date":"0001-01-01T00:00:00.0000000","registration_end_date":"0001-01-01T00:00:00.0000000","add_start_date":"0001-01-01T00:00:00.0000000","add_end_date":"0001-01-01T00:00:00.0000000","drop_start_date":"0001-01-01T00:00:00.0000000","drop_end_date":"0001-01-01T00:00:00.0000000","grading_end_date":"0001-01-01T00:00:00.0000000","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","timestamp":"0001-01-01T00:00:00.0000000"}