regis

RegistrationSummaryRequest

**Requires Authentication**
Required permission:	ReadRegistrationAvailability

The following routes are available for this service:
POST	/registration/summary

"use strict";
export class PersonSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,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?:string,is_student?:boolean,is_faculty?:boolean,is_vendor?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    ubc_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    first_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {?string} */
    dob;
    /** @type {boolean} */
    is_student;
    /** @type {boolean} */
    is_faculty;
    /** @type {boolean} */
    is_vendor;
}
export class StudentAcademicCredentialSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,course_uuid?:string,course_name?:string,section_code?:string,section_id?:number,term?:string,reporting_term?:string,title?:string,amount?:number,is_audit?:boolean,is_pass_fail?:boolean,is_graded?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    course_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {?number} */
    section_id;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    title;
    /** @type {?number} */
    amount;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_pass_fail;
    /** @type {boolean} */
    is_graded;
}
export class StudentAcademicCredentialByReportingTermSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,reportingTerm?:string,onlineCreditsAttempted?:number,onlineAuditsAttempted?:number,studentAcademicCredentialSimpleResponse?:StudentAcademicCredentialSimpleResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    reportingTerm;
    /** @type {number} */
    onlineCreditsAttempted;
    /** @type {number} */
    onlineAuditsAttempted;
    /** @type {StudentAcademicCredentialSimpleResponse[]} */
    studentAcademicCredentialSimpleResponse;
}
export class RegistrationDocumentResponse {
    /** @param {{uuid?:string,regent_id?:number,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?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    gender;
    /** @type {string} */
    email;
    /** @type {string} */
    program;
    /** @type {string} */
    concentration;
    /** @type {string} */
    section_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    course_title;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    document_code;
    /** @type {string} */
    document_json;
    /** @type {string} */
    document_name;
    /** @type {string} */
    document_description;
    /** @type {?string} */
    added_date;
    /** @type {?string} */
    changed_date;
}
export class ProvisionalRegistrationResponse {
    /** @param {{uuid?:string,regent_id?:number,student_name?:string,email?:string,section_uuid?:string,student_section_uuid?:string,course_name?:string,section_code?:string,title?:string,term?:string,amount?:number,is_audit?:boolean,is_waitlist?:boolean,is_missing_requisites?:boolean,is_other_restriction?:boolean,documents?:RegistrationDocumentResponse[],requested_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {?number} */
    regent_id;
    /** @type {string} */
    student_name;
    /** @type {string} */
    email;
    /** @type {string} */
    section_uuid;
    /** @type {string} */
    student_section_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    title;
    /** @type {string} */
    term;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_waitlist;
    /** @type {boolean} */
    is_missing_requisites;
    /** @type {boolean} */
    is_other_restriction;
    /** @type {RegistrationDocumentResponse[]} */
    documents;
    /** @type {string} */
    requested_date;
}
export class ProvisionalRegistrationsForStudentResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,provisional_registrations?:ProvisionalRegistrationResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {ProvisionalRegistrationResponse[]} */
    provisional_registrations;
}
export class RegistrationSummaryResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,is_missing_tax_number?:boolean,person?:PersonSimpleResponse,registrations?:StudentAcademicCredentialByReportingTermSimpleResponse[],provisional_registrations?:ProvisionalRegistrationsForStudentResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {boolean} */
    is_missing_tax_number;
    /** @type {PersonSimpleResponse} */
    person;
    /** @type {StudentAcademicCredentialByReportingTermSimpleResponse[]} */
    registrations;
    /** @type {ProvisionalRegistrationsForStudentResponse} */
    provisional_registrations;
}
export class RegistrationSummaryRequest {
    /** @param {{uuid?:string,from_this_term?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    from_this_term;
}

JavaScript 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>