regis

<back to all web services

StudentGraduationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentGraduation/{uuid}/{year}
"use strict";
export class StudentGraduationProgramResponse {
    /** @param {{program_code?:string,concentration_code?:string,program_details?:string,comments?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    program_code;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    program_details;
    /** @type {string} */
    comments;
}
export class StudentGraduationResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,first_name?:string,preferred_name?:string,middle_name?:string,last_name?:string,email?:string,phonetic_first_name?:string,phonetic_middle_name?:string,phonetic_last_name?:string,placement?:string,placement_other?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,previous_degrees?:string,gown_size?:number,project_title?:string,supervisor?:string,is_attending?:boolean,is_hood_requested?:boolean,is_hood_paid?:boolean,is_paid?:boolean,is_late?:boolean,year?:number,comments?:string,current_status?:string,current_status_date?:string,added_date?:string,applied_programs?:StudentGraduationProgramResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    first_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    phonetic_first_name;
    /** @type {string} */
    phonetic_middle_name;
    /** @type {string} */
    phonetic_last_name;
    /** @type {string} */
    placement;
    /** @type {string} */
    placement_other;
    /** @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} */
    previous_degrees;
    /** @type {?number} */
    gown_size;
    /** @type {string} */
    project_title;
    /** @type {string} */
    supervisor;
    /** @type {boolean} */
    is_attending;
    /** @type {boolean} */
    is_hood_requested;
    /** @type {boolean} */
    is_hood_paid;
    /** @type {boolean} */
    is_paid;
    /** @type {boolean} */
    is_late;
    /** @type {?number} */
    year;
    /** @type {string} */
    comments;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
    /** @type {?string} */
    added_date;
    /** @type {StudentGraduationProgramResponse[]} */
    applied_programs;
}
export class StudentGraduationRequest {
    /** @param {{uuid?:string,year?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    year;
}

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

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

<StudentGraduationResponse 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>
  <added_date>0001-01-01T00:00:00</added_date>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <applied_programs>
    <StudentGraduationProgramResponse>
      <comments>String</comments>
      <concentration_code>String</concentration_code>
      <program_code>String</program_code>
      <program_details>String</program_details>
    </StudentGraduationProgramResponse>
  </applied_programs>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <comments>String</comments>
  <country>String</country>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <email>String</email>
  <first_name>String</first_name>
  <gown_size>0</gown_size>
  <is_attending>false</is_attending>
  <is_hood_paid>false</is_hood_paid>
  <is_hood_requested>false</is_hood_requested>
  <is_late>false</is_late>
  <is_paid>false</is_paid>
  <last_name>String</last_name>
  <middle_name>String</middle_name>
  <permanent_resident>String</permanent_resident>
  <phonetic_first_name>String</phonetic_first_name>
  <phonetic_last_name>String</phonetic_last_name>
  <phonetic_middle_name>String</phonetic_middle_name>
  <placement>String</placement>
  <placement_other>String</placement_other>
  <preferred_name>String</preferred_name>
  <previous_degrees>String</previous_degrees>
  <project_title>String</project_title>
  <regent_id>0</regent_id>
  <state>String</state>
  <supervisor>String</supervisor>
  <uuid>String</uuid>
  <year>0</year>
</StudentGraduationResponse>