regis

AcademicSummaryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/{uuid}/Summary


export class StudentProgramSimpleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public program_id: number;
    public program_code: string;
    public program_name: string;
    public concentration_code: string;
    public concentration_name: string;
    public start_date?: string;
    public end_date?: string;
    public catalog: string;
    public is_active: boolean;
    public is_graduated: boolean;

    public constructor(init?: Partial<StudentProgramSimpleResponse>) { (Object as any).assign(this, init); }
}

export class AcademicSummaryResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public gpa?: number;
    public student_programs: StudentProgramSimpleResponse[];
    public unofficial_undergraduate_degree_description: string;
    public messages: string[];

    public constructor(init?: Partial<AcademicSummaryResponse>) { (Object as any).assign(this, init); }
}

export class AcademicSummaryRequest
{
    public uuid: string;

    public constructor(init?: Partial<AcademicSummaryRequest>) { (Object as any).assign(this, init); }
}

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

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

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

<AcademicSummaryResponse 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>
  <gpa>0</gpa>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <regent_id>0</regent_id>
  <student_programs>
    <StudentProgramSimpleResponse>
      <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>
      <catalog>String</catalog>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <is_active>false</is_active>
      <is_graduated>false</is_graduated>
      <program_code>String</program_code>
      <program_id>0</program_id>
      <program_name>String</program_name>
      <regent_id>0</regent_id>
      <start_date>0001-01-01T00:00:00</start_date>
      <uuid>String</uuid>
    </StudentProgramSimpleResponse>
  </student_programs>
  <unofficial_undergraduate_degree_description>String</unofficial_undergraduate_degree_description>
  <uuid>String</uuid>
</AcademicSummaryResponse>