regis

<back to all web services

RegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}/{transaction_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 RegistrationDocumentResponse() = 
        member val uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val gender:String = null with get,set
        member val email:String = null with get,set
        member val program:String = null with get,set
        member val concentration:String = null with get,set
        member val section_uuid:String = null with get,set
        member val course_name:String = null with get,set
        member val course_title:String = null with get,set
        member val reporting_term:String = null with get,set
        member val document_code:String = null with get,set
        member val document_json:String = null with get,set
        member val document_name:String = null with get,set
        member val document_description:String = null with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type RegistrationInProgressSummaryResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val transaction_uuid:String = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val numberOfStudentSections:Int32 = new Int32() with get,set
        member val amountOwing:Decimal = new Decimal() with get,set
        member val mustPayBeforeRegistering:Boolean = new Boolean() with get,set
        member val requiredDocuments:ResizeArray<RegistrationDocumentResponse> = new ResizeArray<RegistrationDocumentResponse>() with get,set
        member val completedDocuments:ResizeArray<RegistrationDocumentResponse> = new ResizeArray<RegistrationDocumentResponse>() with get,set
        member val isLate:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RegistrationInProgressSummaryRequest() = 
        member val uuid:String = null with get,set
        member val transaction_uuid:String = null with get,set
        member val reporting_term:String = null with get,set
        member val online_only:Boolean = new Boolean() with get,set

F# RegistrationInProgressSummaryRequest 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 /Registration/InProgressSummary/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","transaction_uuid":"String","reporting_term":"String","online_only":false}
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"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}