regis

<back to all web services

StudentTransferCredentialPackageUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}/Update/{equivalent_id}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentTransferCredentialUpdateRequest:
    uuid: Optional[str] = None
    stran_uuid: Optional[str] = None
    course_name: Optional[str] = None
    title: Optional[str] = None
    credit_value: Decimal = decimal.Decimal(0)
    authorizing_uuid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentAcademicCredentialUpdateRequest:
    uuid: Optional[str] = None
    stac_uuid: Optional[str] = None
    section_id: Optional[int] = None
    course_name: Optional[str] = None
    section_code: Optional[str] = None
    subject: Optional[str] = None
    course_level: Optional[int] = None
    title: Optional[str] = None
    location: Optional[str] = None
    is_audio: bool = False
    is_oncampus: bool = False
    credit_value: Optional[Decimal] = None
    audit_value: Optional[Decimal] = None
    is_audit: bool = False
    is_pass_fail: bool = False
    grade: Optional[str] = None
    is_grade_final: bool = False
    gpa_credits: Optional[Decimal] = None
    grade_points: Optional[Decimal] = None
    academic_level: Optional[str] = None
    printed_comments: Optional[str] = None
    term: Optional[str] = None
    reporting_term: Optional[str] = None
    reporting_year: Optional[int] = None
    current_status: Optional[str] = None
    authorizing_uuid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentTransferCredentialPackageUpdateRequest:
    uuid: Optional[str] = None
    equivalent_id: int = 0
    is_advanced_standing: bool = False
    institution_id: int = 0
    authorizing_uuid: Optional[str] = None
    student_transfer_credential_update_request: Optional[List[StudentTransferCredentialUpdateRequest]] = None
    student_academic_credential_update_request: Optional[List[StudentAcademicCredentialUpdateRequest]] = None

Python StudentTransferCredentialPackageUpdateRequest 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}/Update/{equivalent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StudentTransferCredentialPackageUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <equivalent_id>0</equivalent_id>
  <institution_id>0</institution_id>
  <is_advanced_standing>false</is_advanced_standing>
  <studentAcademicCredentialUpdateRequest>
    <StudentAcademicCredentialUpdateRequest>
      <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>
      <stac_uuid>String</stac_uuid>
      <subject>String</subject>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
    </StudentAcademicCredentialUpdateRequest>
  </studentAcademicCredentialUpdateRequest>
  <studentTransferCredentialUpdateRequest>
    <StudentTransferCredentialUpdateRequest>
      <authorizing_uuid>String</authorizing_uuid>
      <course_name>String</course_name>
      <credit_value>0</credit_value>
      <stran_uuid>String</stran_uuid>
      <title>String</title>
      <uuid>String</uuid>
    </StudentTransferCredentialUpdateRequest>
  </studentTransferCredentialUpdateRequest>
  <uuid>String</uuid>
</StudentTransferCredentialPackageUpdateRequest>
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>