regis

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 .xml suffix or ?format=xml

HTTP + XML

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

<RegistrationSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <from_this_term>String</from_this_term>
  <uuid>String</uuid>
</RegistrationSummaryRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <is_missing_tax_number>false</is_missing_tax_number>
  <person>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <citizenship>String</citizenship>
    <citizenship_other>String</citizenship_other>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <dob>0001-01-01T00:00:00</dob>
    <email>String</email>
    <first_name>String</first_name>
    <is_faculty>false</is_faculty>
    <is_student>false</is_student>
    <is_vendor>false</is_vendor>
    <last_name>String</last_name>
    <middle_name>String</middle_name>
    <permanent_resident>String</permanent_resident>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <preferred_name>String</preferred_name>
    <regent_id>0</regent_id>
    <regent_login>String</regent_login>
    <state>String</state>
    <ubc_id>0</ubc_id>
    <uuid>String</uuid>
  </person>
  <provisional_registrations>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <provisional_registrations>
      <ProvisionalRegistrationResponse>
        <amount>0</amount>
        <course_name>String</course_name>
        <documents>
          <RegistrationDocumentResponse>
            <added_date>0001-01-01T00:00:00</added_date>
            <changed_date>0001-01-01T00:00:00</changed_date>
            <concentration>String</concentration>
            <course_name>String</course_name>
            <course_title>String</course_title>
            <document_code>String</document_code>
            <document_description>String</document_description>
            <document_json>String</document_json>
            <document_name>String</document_name>
            <email>String</email>
            <first_name>String</first_name>
            <gender>String</gender>
            <last_name>String</last_name>
            <program>String</program>
            <regent_id>0</regent_id>
            <reporting_term>String</reporting_term>
            <section_uuid>String</section_uuid>
            <uuid>String</uuid>
          </RegistrationDocumentResponse>
        </documents>
        <email>String</email>
        <is_audit>false</is_audit>
        <is_missing_requisites>false</is_missing_requisites>
        <is_other_restriction>false</is_other_restriction>
        <is_waitlist>false</is_waitlist>
        <regent_id>0</regent_id>
        <requested_date>0001-01-01T00:00:00</requested_date>
        <section_code>String</section_code>
        <section_uuid>String</section_uuid>
        <student_name>String</student_name>
        <student_section_uuid>String</student_section_uuid>
        <term>String</term>
        <title>String</title>
        <uuid>String</uuid>
      </ProvisionalRegistrationResponse>
    </provisional_registrations>
    <regent_id>0</regent_id>
    <uuid>String</uuid>
  </provisional_registrations>
  <regent_id>0</regent_id>
  <registrations>
    <StudentAcademicCredentialByReportingTermSimpleResponse>
      <OnlineAuditsAttempted>0</OnlineAuditsAttempted>
      <OnlineCreditsAttempted>0</OnlineCreditsAttempted>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <reportingTerm>String</reportingTerm>
      <studentAcademicCredentialSimpleResponse>
        <StudentAcademicCredentialSimpleResponse>
          <ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types">
            <d6p1:ErrorCode>String</d6p1:ErrorCode>
            <d6p1:Message>String</d6p1:Message>
            <d6p1:StackTrace>String</d6p1:StackTrace>
            <d6p1:Errors>
              <d6p1:ResponseError>
                <d6p1:ErrorCode>String</d6p1:ErrorCode>
                <d6p1:FieldName>String</d6p1:FieldName>
                <d6p1:Message>String</d6p1:Message>
                <d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </d6p1:Meta>
              </d6p1:ResponseError>
            </d6p1:Errors>
            <d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d6p1:Meta>
          </ResponseStatus>
          <amount>0</amount>
          <course_name>String</course_name>
          <course_uuid>String</course_uuid>
          <is_audit>false</is_audit>
          <is_graded>false</is_graded>
          <is_pass_fail>false</is_pass_fail>
          <reporting_term>String</reporting_term>
          <section_code>String</section_code>
          <section_id>0</section_id>
          <term>String</term>
          <title>String</title>
        </StudentAcademicCredentialSimpleResponse>
      </studentAcademicCredentialSimpleResponse>
    </StudentAcademicCredentialByReportingTermSimpleResponse>
  </registrations>
  <uuid>String</uuid>
</RegistrationSummaryResponse>