regis

<back to all web services

StudentAcademicCredentialAdditionalInstructorsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentAcademicCredential/{uuid}/AdditionalInstructors/{stac_uuid}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class InstructorResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? regent_login;
    String? preferred_name;
    String? first_name;
    String? last_name;
    String? full_name;
    String? email;
    String? image_base64;

    InstructorResponse({this.responseStatus,this.regent_id,this.regent_login,this.preferred_name,this.first_name,this.last_name,this.full_name,this.email,this.image_base64});
    InstructorResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        regent_login = json['regent_login'];
        preferred_name = json['preferred_name'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        full_name = json['full_name'];
        email = json['email'];
        image_base64 = json['image_base64'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'regent_login': regent_login,
        'preferred_name': preferred_name,
        'first_name': first_name,
        'last_name': last_name,
        'full_name': full_name,
        'email': email,
        'image_base64': image_base64
    };

    getTypeName() => "InstructorResponse";
    TypeContext? context = _ctx;
}

class StudentAcademicCredentialAdditionalInstructorsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    String? stac_uuid;
    String? course_name;
    String? term;
    String? reporting_term;
    List<InstructorResponse>? instructors;

    StudentAcademicCredentialAdditionalInstructorsResponse({this.responseStatus,this.uuid,this.stac_uuid,this.course_name,this.term,this.reporting_term,this.instructors});
    StudentAcademicCredentialAdditionalInstructorsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        uuid = json['uuid'];
        stac_uuid = json['stac_uuid'];
        course_name = json['course_name'];
        term = json['term'];
        reporting_term = json['reporting_term'];
        instructors = JsonConverters.fromJson(json['instructors'],'List<InstructorResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'uuid': uuid,
        'stac_uuid': stac_uuid,
        'course_name': course_name,
        'term': term,
        'reporting_term': reporting_term,
        'instructors': JsonConverters.toJson(instructors,'List<InstructorResponse>',context!)
    };

    getTypeName() => "StudentAcademicCredentialAdditionalInstructorsResponse";
    TypeContext? context = _ctx;
}

class StudentAcademicCredentialAdditionalInstructorsRequest implements IConvertible
{
    String? uuid;
    String? stac_uuid;

    StudentAcademicCredentialAdditionalInstructorsRequest({this.uuid,this.stac_uuid});
    StudentAcademicCredentialAdditionalInstructorsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        stac_uuid = json['stac_uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'stac_uuid': stac_uuid
    };

    getTypeName() => "StudentAcademicCredentialAdditionalInstructorsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'InstructorResponse': TypeInfo(TypeOf.Class, create:() => InstructorResponse()),
    'StudentAcademicCredentialAdditionalInstructorsResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialAdditionalInstructorsResponse()),
    'List<InstructorResponse>': TypeInfo(TypeOf.Class, create:() => <InstructorResponse>[]),
    'StudentAcademicCredentialAdditionalInstructorsRequest': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialAdditionalInstructorsRequest()),
});

Dart StudentAcademicCredentialAdditionalInstructorsRequest 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 /StudentAcademicCredential/{uuid}/AdditionalInstructors/{stac_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StudentAcademicCredentialAdditionalInstructorsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <stac_uuid>String</stac_uuid>
  <uuid>String</uuid>
</StudentAcademicCredentialAdditionalInstructorsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StudentAcademicCredentialAdditionalInstructorsResponse 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>
  <course_name>String</course_name>
  <instructors>
    <InstructorResponse>
      <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>
      <email>String</email>
      <first_name>String</first_name>
      <full_name>String</full_name>
      <image_base64>String</image_base64>
      <last_name>String</last_name>
      <preferred_name>String</preferred_name>
      <regent_id>0</regent_id>
      <regent_login>String</regent_login>
    </InstructorResponse>
  </instructors>
  <reporting_term>String</reporting_term>
  <stac_uuid>String</stac_uuid>
  <term>String</term>
  <uuid>String</uuid>
</StudentAcademicCredentialAdditionalInstructorsResponse>