regis

<back to all web services

StudentGraduationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentGraduation/{uuid}/{year}
import Foundation
import ServiceStack

public class StudentGraduationRequest : Codable
{
    public var uuid:String
    public var year:Int

    required public init(){}
}

public class StudentGraduationResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var first_name:String
    public var preferred_name:String
    public var middle_name:String
    public var last_name:String
    public var email:String
    public var phonetic_first_name:String
    public var phonetic_middle_name:String
    public var phonetic_last_name:String
    public var placement:String
    public var placement_other:String
    public var addr1:String
    public var addr2:String
    public var city:String
    public var state:String
    public var country:String
    public var code:String
    public var citizenship:String
    public var citizenship_other:String
    public var permanent_resident:String
    public var previous_degrees:String
    public var gown_size:Int?
    public var project_title:String
    public var supervisor:String
    public var is_attending:Bool
    public var is_hood_requested:Bool
    public var is_hood_paid:Bool
    public var is_paid:Bool
    public var is_late:Bool
    public var year:Int?
    public var comments:String
    public var current_status:String
    public var current_status_date:Date?
    public var added_date:Date?
    public var applied_programs:[StudentGraduationProgramResponse] = []

    required public init(){}
}

public class StudentGraduationProgramResponse : Codable
{
    public var program_code:String
    public var concentration_code:String
    public var program_details:String
    public var comments:String

    required public init(){}
}


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