regis

<back to all web services

RegentDegreesRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/RegentDegrees
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type RegentDegreeResponse() = 
        member val id:Int32 = new Int32() with get,set
        member val program_code:String = null with get,set
        member val program_name:String = null with get,set
        member val concentration_code:String = null with get,set
        member val concentration_name:String = null with get,set
        member val graduation_month:Nullable<DateTime> = new Nullable<DateTime>() 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 gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val academic_level:String = null with get,set
        member val commencement_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ProgramResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val id:Int32 = new Int32() with get,set
        member val program_code:String = null with get,set
        member val program_pretty_code:String = null with get,set
        member val program_long_name:String = null with get,set
        member val available_concentrations:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ConcentrationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val id:Int32 = new Int32() with get,set
        member val concentration_code:String = null with get,set
        member val concentration_name:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CatalogResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val id:Int32 = new Int32() with get,set
        member val catalog_code:String = null with get,set

    [<AllowNullLiteral>]
    type RegentDegreesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val regent_degrees:ResizeArray<RegentDegreeResponse> = new ResizeArray<RegentDegreeResponse>() with get,set
        member val valid_programs:ResizeArray<ProgramResponse> = new ResizeArray<ProgramResponse>() with get,set
        member val valid_concentrations:ResizeArray<ConcentrationResponse> = new ResizeArray<ConcentrationResponse>() with get,set
        member val valid_catalogs:ResizeArray<CatalogResponse> = new ResizeArray<CatalogResponse>() with get,set

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

F# RegentDegreesRequest DTOs

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

HTTP + CSV

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

POST /Academic/{uuid}/RegentDegrees HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","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"}],"valid_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"program_code":"String","program_pretty_code":"String","program_long_name":"String","available_concentrations":"String","is_active":false,"timestamp":"0001-01-01T00:00:00.0000000"}],"valid_concentrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"concentration_code":"String","concentration_name":"String","is_active":false}],"valid_catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}