regis

<back to all web services

StudentTransferCredentialPackageCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}/Create
"use strict";
export class StudentTransferCredentialCreateRequest {
    /** @param {{uuid?:string,course_name?:string,title?:string,credit_value?:number,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {number} */
    credit_value;
    /** @type {string} */
    authorizing_uuid;
}
export class StudentAcademicCredentialCreateRequest {
    /** @param {{uuid?:string,section_id?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,location?:string,is_audio?:boolean,is_oncampus?:boolean,credit_value?:number,audit_value?:number,is_audit?:boolean,is_pass_fail?:boolean,grade?:string,is_grade_final?:boolean,gpa_credits?:number,grade_points?:number,academic_level?:string,printed_comments?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {?number} */
    section_id;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    subject;
    /** @type {?number} */
    course_level;
    /** @type {string} */
    title;
    /** @type {string} */
    location;
    /** @type {boolean} */
    is_audio;
    /** @type {boolean} */
    is_oncampus;
    /** @type {?number} */
    credit_value;
    /** @type {?number} */
    audit_value;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_pass_fail;
    /** @type {string} */
    grade;
    /** @type {boolean} */
    is_grade_final;
    /** @type {?number} */
    gpa_credits;
    /** @type {?number} */
    grade_points;
    /** @type {string} */
    academic_level;
    /** @type {string} */
    printed_comments;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {?number} */
    reporting_year;
    /** @type {string} */
    current_status;
    /** @type {string} */
    authorizing_uuid;
}
export class StudentTransferCredentialPackageCreateRequest {
    /** @param {{uuid?:string,institution_id?:number,authorizing_uuid?:string,is_advanced_standing?:boolean,studentTransferCredentialCreateRequest?:StudentTransferCredentialCreateRequest[],studentAcademicCredentialCreateRequest?:StudentAcademicCredentialCreateRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    institution_id;
    /** @type {string} */
    authorizing_uuid;
    /** @type {boolean} */
    is_advanced_standing;
    /** @type {StudentTransferCredentialCreateRequest[]} */
    studentTransferCredentialCreateRequest;
    /** @type {StudentAcademicCredentialCreateRequest[]} */
    studentAcademicCredentialCreateRequest;
}

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

<StudentTransferCredentialPackageCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <institution_id>0</institution_id>
  <is_advanced_standing>false</is_advanced_standing>
  <studentAcademicCredentialCreateRequest>
    <StudentAcademicCredentialCreateRequest>
      <academic_level>String</academic_level>
      <audit_value>0</audit_value>
      <authorizing_uuid>String</authorizing_uuid>
      <course_level>0</course_level>
      <course_name>String</course_name>
      <credit_value>0</credit_value>
      <current_status>String</current_status>
      <gpa_credits>0</gpa_credits>
      <grade>String</grade>
      <grade_points>0</grade_points>
      <is_audio>false</is_audio>
      <is_audit>false</is_audit>
      <is_grade_final>false</is_grade_final>
      <is_oncampus>false</is_oncampus>
      <is_pass_fail>false</is_pass_fail>
      <location>String</location>
      <printed_comments>String</printed_comments>
      <reporting_term>String</reporting_term>
      <reporting_year>0</reporting_year>
      <section_code>String</section_code>
      <section_id>0</section_id>
      <subject>String</subject>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
    </StudentAcademicCredentialCreateRequest>
  </studentAcademicCredentialCreateRequest>
  <studentTransferCredentialCreateRequest>
    <StudentTransferCredentialCreateRequest>
      <authorizing_uuid>String</authorizing_uuid>
      <course_name>String</course_name>
      <credit_value>0</credit_value>
      <title>String</title>
      <uuid>String</uuid>
    </StudentTransferCredentialCreateRequest>
  </studentTransferCredentialCreateRequest>
  <uuid>String</uuid>
</StudentTransferCredentialPackageCreateRequest>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>