regis

ProvisionalRegistrationsForStudentRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/{uuid}/Provisional

"use strict";
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 ProvisionalRegistrationsForStudentRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript ProvisionalRegistrationsForStudentRequest 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/{uuid}/Provisional HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<ProvisionalRegistrationsForStudentResponse 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>
  <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>
</ProvisionalRegistrationsForStudentResponse>