regis

AddressHistoryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/admissions/{uuid}/address/history

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class AddressResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? addr1;
    String? addr2;
    String? country;
    String? country_code;
    String? state;
    String? city;
    String? code;
    DateTime? start_date;
    DateTime? end_date;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;

    AddressResponse({this.responseStatus,this.addr1,this.addr2,this.country,this.country_code,this.state,this.city,this.code,this.start_date,this.end_date,this.added_by,this.added_date,this.changed_by,this.changed_date});
    AddressResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        country = json['country'];
        country_code = json['country_code'];
        state = json['state'];
        city = json['city'];
        code = json['code'];
        start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
        end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
        added_by = json['added_by'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_by = json['changed_by'];
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'addr1': addr1,
        'addr2': addr2,
        'country': country,
        'country_code': country_code,
        'state': state,
        'city': city,
        'code': code,
        'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
        'end_date': JsonConverters.toJson(end_date,'DateTime',context!),
        'added_by': added_by,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_by': changed_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!)
    };

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

class PhoneEmailResponse implements IConvertible
{
    String? phone_home;
    String? phone_cell;
    String? phone_bus;
    String? email;
    DateTime? start_date;
    DateTime? end_date;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;

    PhoneEmailResponse({this.phone_home,this.phone_cell,this.phone_bus,this.email,this.start_date,this.end_date,this.added_by,this.added_date,this.changed_by,this.changed_date});
    PhoneEmailResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        phone_home = json['phone_home'];
        phone_cell = json['phone_cell'];
        phone_bus = json['phone_bus'];
        email = json['email'];
        start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
        end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
        added_by = json['added_by'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_by = json['changed_by'];
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'phone_home': phone_home,
        'phone_cell': phone_cell,
        'phone_bus': phone_bus,
        'email': email,
        'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
        'end_date': JsonConverters.toJson(end_date,'DateTime',context!),
        'added_by': added_by,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_by': changed_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!)
    };

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

class AddressPhoneEmailResponse implements IConvertible
{
    String? uuid;
    int? regent_id;
    AddressResponse? address;
    PhoneEmailResponse? phone;

    AddressPhoneEmailResponse({this.uuid,this.regent_id,this.address,this.phone});
    AddressPhoneEmailResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        address = JsonConverters.fromJson(json['address'],'AddressResponse',context!);
        phone = JsonConverters.fromJson(json['phone'],'PhoneEmailResponse',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'regent_id': regent_id,
        'address': JsonConverters.toJson(address,'AddressResponse',context!),
        'phone': JsonConverters.toJson(phone,'PhoneEmailResponse',context!)
    };

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

class AddressHistoryResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    int? regent_id;
    List<AddressPhoneEmailResponse>? addresses;

    AddressHistoryResponse({this.responseStatus,this.uuid,this.regent_id,this.addresses});
    AddressHistoryResponse.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'];
        addresses = JsonConverters.fromJson(json['addresses'],'List<AddressPhoneEmailResponse>',context!);
        return this;
    }

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

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

class AddressHistoryRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'AddressResponse': TypeInfo(TypeOf.Class, create:() => AddressResponse()),
    'PhoneEmailResponse': TypeInfo(TypeOf.Class, create:() => PhoneEmailResponse()),
    'AddressPhoneEmailResponse': TypeInfo(TypeOf.Class, create:() => AddressPhoneEmailResponse()),
    'AddressHistoryResponse': TypeInfo(TypeOf.Class, create:() => AddressHistoryResponse()),
    'List<AddressPhoneEmailResponse>': TypeInfo(TypeOf.Class, create:() => <AddressPhoneEmailResponse>[]),
    'AddressHistoryRequest': TypeInfo(TypeOf.Class, create:() => AddressHistoryRequest()),
});

Dart AddressHistoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /admissions/{uuid}/address/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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,"addresses":[{"uuid":"String","regent_id":0,"address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"phone":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}}]}