regis

<back to all web services

SectionTARequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Sections/TA/{uuid}
"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 SectionTAResponse {
    /** @param {{uuid?:string,course_name?:string,title?:string,term?:string,reporting_term?:string,taList?:PersonSimpleResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {PersonSimpleResponse[]} */
    taList;
}
export class SectionTARequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

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

<SectionTARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</SectionTARequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SectionTAResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <TAList>
    <PersonSimpleResponse>
      <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>
      <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>
    </PersonSimpleResponse>
  </TAList>
  <course_name>String</course_name>
  <reporting_term>String</reporting_term>
  <term>String</term>
  <title>String</title>
  <uuid>String</uuid>
</SectionTAResponse>