regis

RegentDegreesRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class RegentDegreeResponse {
    /** @param {{id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,graduation_month?:string,start_date?:string,end_date?:string,gpa?:number,academic_level?:string,commencement_date?:string,added_date?:string,added_by?:string,changed_date?:string,changed_by?:string,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_name;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    concentration_name;
    /** @type {?string} */
    graduation_month;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {?number} */
    gpa;
    /** @type {string} */
    academic_level;
    /** @type {?string} */
    commencement_date;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    changed_by;
    /** @type {string} */
    timestamp;
}
export class ProgramResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,program_code?:string,program_pretty_code?:string,program_long_name?:string,available_concentrations?:string,is_active?:boolean,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_pretty_code;
    /** @type {string} */
    program_long_name;
    /** @type {string} */
    available_concentrations;
    /** @type {boolean} */
    is_active;
    /** @type {string} */
    timestamp;
}
export class ConcentrationResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,concentration_code?:string,concentration_name?:string,is_active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    concentration_name;
    /** @type {boolean} */
    is_active;
}
export class CatalogResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,catalog_code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    catalog_code;
}
export class RegentDegreesResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,regent_degrees?:RegentDegreeResponse[],valid_programs?:ProgramResponse[],valid_concentrations?:ConcentrationResponse[],valid_catalogs?:CatalogResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {RegentDegreeResponse[]} */
    regent_degrees;
    /** @type {ProgramResponse[]} */
    valid_programs;
    /** @type {ConcentrationResponse[]} */
    valid_concentrations;
    /** @type {CatalogResponse[]} */
    valid_catalogs;
}
export class RegentDegreesRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

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

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

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

<RegentDegreesResponse 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>
  <regent_degrees>
    <RegentDegreeResponse>
      <academic_level>String</academic_level>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <commencement_date>0001-01-01T00:00:00</commencement_date>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <gpa>0</gpa>
      <graduation_month>0001-01-01T00:00:00</graduation_month>
      <id>0</id>
      <program_code>String</program_code>
      <program_name>String</program_name>
      <start_date>0001-01-01T00:00:00</start_date>
      <timestamp>0001-01-01T00:00:00</timestamp>
    </RegentDegreeResponse>
  </regent_degrees>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
  <valid_catalogs>
    <CatalogResponse>
      <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_code>String</catalog_code>
      <id>0</id>
    </CatalogResponse>
  </valid_catalogs>
  <valid_concentrations>
    <ConcentrationResponse>
      <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>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <id>0</id>
      <is_active>false</is_active>
    </ConcentrationResponse>
  </valid_concentrations>
  <valid_programs>
    <ProgramResponse>
      <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>
      <available_concentrations>String</available_concentrations>
      <id>0</id>
      <is_active>false</is_active>
      <program_code>String</program_code>
      <program_long_name>String</program_long_name>
      <program_pretty_code>String</program_pretty_code>
      <timestamp>0001-01-01T00:00:00</timestamp>
    </ProgramResponse>
  </valid_programs>
</RegentDegreesResponse>