regis

<back to all web services

NameHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/name/history
import 'package:servicestack/servicestack.dart';

class NameResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? first_name;
    String? last_name;
    String? middle_name;
    String? preferred_name;
    String? prefix;
    DateTime? created_date;

    NameResponse({this.responseStatus,this.first_name,this.last_name,this.middle_name,this.preferred_name,this.prefix,this.created_date});
    NameResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        first_name = json['first_name'];
        last_name = json['last_name'];
        middle_name = json['middle_name'];
        preferred_name = json['preferred_name'];
        prefix = json['prefix'];
        created_date = JsonConverters.fromJson(json['created_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'first_name': first_name,
        'last_name': last_name,
        'middle_name': middle_name,
        'preferred_name': preferred_name,
        'prefix': prefix,
        'created_date': JsonConverters.toJson(created_date,'DateTime',context!)
    };

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

class NameHistoryResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    int? regent_id;
    List<NameResponse>? names;

    NameHistoryResponse({this.responseStatus,this.uuid,this.regent_id,this.names});
    NameHistoryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class NameHistoryRequest implements IConvertible
{
    String? uuid;

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

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

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

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

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

Dart NameHistoryRequest 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 /admissions/{uuid}/name/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: 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
		}
	},
	uuid: String,
	regent_id: 0,
	names: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			first_name: String,
			last_name: String,
			middle_name: String,
			preferred_name: String,
			prefix: String,
			created_date: 0001-01-01
		}
	]
}