regis

<back to all web services

CanIRegisterRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/CanIRegister/{uuid}/Term/{reporting_term}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class CanIRegisterResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    String? reporting_term;
    double? maxCredits;
    double? maxAudits;
    List<String>? messages;

    CanIRegisterResponse({this.responseStatus,this.regent_id,this.uuid,this.reporting_term,this.maxCredits,this.maxAudits,this.messages});
    CanIRegisterResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        reporting_term = json['reporting_term'];
        maxCredits = JsonConverters.toDouble(json['maxCredits']);
        maxAudits = JsonConverters.toDouble(json['maxAudits']);
        messages = JsonConverters.fromJson(json['messages'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'reporting_term': reporting_term,
        'maxCredits': maxCredits,
        'maxAudits': maxAudits,
        'messages': JsonConverters.toJson(messages,'List<String>',context!)
    };

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

class CanIRegisterRequest implements IConvertible
{
    String? uuid;
    String? term;
    String? reporting_term;

    CanIRegisterRequest({this.uuid,this.term,this.reporting_term});
    CanIRegisterRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'CanIRegisterResponse': TypeInfo(TypeOf.Class, create:() => CanIRegisterResponse()),
    'CanIRegisterRequest': TypeInfo(TypeOf.Class, create:() => CanIRegisterRequest()),
});

Dart CanIRegisterRequest 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 /Registration/CanIRegister/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<CanIRegisterResponse 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>
  <maxAudits>0</maxAudits>
  <maxCredits>0</maxCredits>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</CanIRegisterResponse>