regis

<back to all web services

RegistrationSummaryRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/registration/summary
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class RegistrationSummaryRequest
    {
        public virtual string uuid { get; set; }
        public virtual string from_this_term { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class PersonSimpleResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual int? ubc_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string regent_login { get; set; }
        public virtual string first_name { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string middle_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string email { get; set; }
        public virtual string phone_home { get; set; }
        public virtual string phone_cell { get; set; }
        public virtual string phone_bus { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string country { get; set; }
        public virtual string code { get; set; }
        public virtual string citizenship { get; set; }
        public virtual string citizenship_other { get; set; }
        public virtual string permanent_resident { get; set; }
        public virtual DateTime? dob { get; set; }
        public virtual bool is_student { get; set; }
        public virtual bool is_faculty { get; set; }
        public virtual bool is_vendor { get; set; }
    }

    public partial class ProvisionalRegistrationResponse
    {
        public ProvisionalRegistrationResponse()
        {
            documents = new List<RegistrationDocumentResponse>{};
        }

        public virtual string uuid { get; set; }
        public virtual int? regent_id { get; set; }
        public virtual string student_name { get; set; }
        public virtual string email { get; set; }
        public virtual string section_uuid { get; set; }
        public virtual string student_section_uuid { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string title { get; set; }
        public virtual string term { get; set; }
        public virtual decimal amount { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_waitlist { get; set; }
        public virtual bool is_missing_requisites { get; set; }
        public virtual bool is_other_restriction { get; set; }
        public virtual List<RegistrationDocumentResponse> documents { get; set; }
        public virtual DateTime requested_date { get; set; }
    }

    public partial class ProvisionalRegistrationsForStudentResponse
    {
        public ProvisionalRegistrationsForStudentResponse()
        {
            provisional_registrations = new List<ProvisionalRegistrationResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual List<ProvisionalRegistrationResponse> provisional_registrations { get; set; }
    }

    public partial class RegistrationDocumentResponse
    {
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string gender { get; set; }
        public virtual string email { get; set; }
        public virtual string program { get; set; }
        public virtual string concentration { get; set; }
        public virtual string section_uuid { get; set; }
        public virtual string course_name { get; set; }
        public virtual string course_title { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual string document_code { get; set; }
        public virtual string document_json { get; set; }
        public virtual string document_name { get; set; }
        public virtual string document_description { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

    public partial class RegistrationSummaryResponse
    {
        public RegistrationSummaryResponse()
        {
            registrations = new List<StudentAcademicCredentialByReportingTermSimpleResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual bool is_missing_tax_number { get; set; }
        public virtual PersonSimpleResponse person { get; set; }
        public virtual List<StudentAcademicCredentialByReportingTermSimpleResponse> registrations { get; set; }
        public virtual ProvisionalRegistrationsForStudentResponse provisional_registrations { get; set; }
    }

    public partial class StudentAcademicCredentialByReportingTermSimpleResponse
    {
        public StudentAcademicCredentialByReportingTermSimpleResponse()
        {
            studentAcademicCredentialSimpleResponse = new List<StudentAcademicCredentialSimpleResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string reportingTerm { get; set; }
        public virtual decimal OnlineCreditsAttempted { get; set; }
        public virtual decimal OnlineAuditsAttempted { get; set; }
        public virtual List<StudentAcademicCredentialSimpleResponse> studentAcademicCredentialSimpleResponse { get; set; }
    }

    public partial class StudentAcademicCredentialSimpleResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string course_uuid { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual int? section_id { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual string title { get; set; }
        public virtual decimal? amount { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_pass_fail { get; set; }
        public virtual bool is_graded { get; set; }
    }

}

C# RegistrationSummaryRequest 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 /registration/summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","from_this_term":"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"}},"regent_id":0,"uuid":"String","is_missing_tax_number":false,"person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false},"registrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reportingTerm":"String","onlineCreditsAttempted":0,"onlineAuditsAttempted":0,"studentAcademicCredentialSimpleResponse":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"course_uuid":"String","course_name":"String","section_code":"String","section_id":0,"term":"String","reporting_term":"String","title":"String","amount":0,"is_audit":false,"is_pass_fail":false,"is_graded":false}]}],"provisional_registrations":{"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","provisional_registrations":[{"uuid":"String","regent_id":0,"student_name":"String","email":"String","section_uuid":"String","student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_waitlist":false,"is_missing_requisites":false,"is_other_restriction":false,"documents":[{"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"}],"requested_date":"0001-01-01T00:00:00.0000000"}]}}