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';

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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	term: String,
	reporting_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	maxCredits: 0,
	maxAudits: 0,
	messages: 
	[
		String
	]
}