regis

<back to all web services

StudentTransferCredentialPackageCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}/Create

export class StudentTransferCredentialCreateRequest
{
    public uuid: string;
    public course_name: string;
    public title: string;
    public credit_value: number;
    public authorizing_uuid: string;

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

export class StudentAcademicCredentialCreateRequest
{
    public uuid: string;
    public section_id?: number;
    public course_name: string;
    public section_code: string;
    public subject: string;
    public course_level?: number;
    public title: string;
    public location: string;
    public is_audio: boolean;
    public is_oncampus: boolean;
    public credit_value?: number;
    public audit_value?: number;
    public is_audit: boolean;
    public is_pass_fail: boolean;
    public grade: string;
    public is_grade_final: boolean;
    public gpa_credits?: number;
    public grade_points?: number;
    public academic_level: string;
    public printed_comments: string;
    public term: string;
    public reporting_term: string;
    public reporting_year?: number;
    public current_status: string;
    public authorizing_uuid: string;

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

export class StudentTransferCredentialPackageCreateRequest
{
    public uuid: string;
    public institution_id: number;
    public authorizing_uuid: string;
    public is_advanced_standing: boolean;
    public studentTransferCredentialCreateRequest: StudentTransferCredentialCreateRequest[];
    public studentAcademicCredentialCreateRequest: StudentAcademicCredentialCreateRequest[];

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

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