regis

<back to all web services

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 .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 /admissions/{uuid}/address/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<AddressHistoryResponse 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>
  <addresses>
    <AddressPhoneEmailResponse>
      <address>
        <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types">
          <d5p1:ErrorCode>String</d5p1:ErrorCode>
          <d5p1:Message>String</d5p1:Message>
          <d5p1:StackTrace>String</d5p1:StackTrace>
          <d5p1:Errors>
            <d5p1:ResponseError>
              <d5p1:ErrorCode>String</d5p1:ErrorCode>
              <d5p1:FieldName>String</d5p1:FieldName>
              <d5p1:Message>String</d5p1:Message>
              <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d5p1:Meta>
            </d5p1:ResponseError>
          </d5p1:Errors>
          <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1:Meta>
        </ResponseStatus>
        <added_by>String</added_by>
        <added_date>0001-01-01T00:00:00</added_date>
        <addr1>String</addr1>
        <addr2>String</addr2>
        <changed_by>String</changed_by>
        <changed_date>0001-01-01T00:00:00</changed_date>
        <city>String</city>
        <code>String</code>
        <country>String</country>
        <country_code>String</country_code>
        <end_date>0001-01-01T00:00:00</end_date>
        <start_date>0001-01-01T00:00:00</start_date>
        <state>String</state>
      </address>
      <phone>
        <added_by>String</added_by>
        <added_date>0001-01-01T00:00:00</added_date>
        <changed_by>String</changed_by>
        <changed_date>0001-01-01T00:00:00</changed_date>
        <email>String</email>
        <end_date>0001-01-01T00:00:00</end_date>
        <phone_bus>String</phone_bus>
        <phone_cell>String</phone_cell>
        <phone_home>String</phone_home>
        <start_date>0001-01-01T00:00:00</start_date>
      </phone>
      <regent_id>0</regent_id>
      <uuid>String</uuid>
    </AddressPhoneEmailResponse>
  </addresses>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</AddressHistoryResponse>