regis

<back to all web services

AddressSyncRequest

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

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 AddressSyncResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    int? regent_id;
    AddressResponse? sugar_address;
    PhoneEmailResponse? sugar_phone_email;
    AddressResponse? regis_address;
    PhoneEmailResponse? regis_phone_email;
    AddressResponse? re_address;
    PhoneEmailResponse? re_phone_email;
    bool? exists_in_sugar;
    bool? exists_in_re;
    bool? are_equal;
    bool? addr_are_equal;
    bool? city_are_equal;
    bool? state_are_equal;
    bool? country_are_equal;
    bool? code_are_equal;
    bool? phone_home_are_equal;
    bool? phone_cell_are_equal;
    bool? phone_bus_are_equal;
    bool? email_are_equal;

    AddressSyncResponse({this.responseStatus,this.uuid,this.regent_id,this.sugar_address,this.sugar_phone_email,this.regis_address,this.regis_phone_email,this.re_address,this.re_phone_email,this.exists_in_sugar,this.exists_in_re,this.are_equal,this.addr_are_equal,this.city_are_equal,this.state_are_equal,this.country_are_equal,this.code_are_equal,this.phone_home_are_equal,this.phone_cell_are_equal,this.phone_bus_are_equal,this.email_are_equal});
    AddressSyncResponse.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'];
        sugar_address = JsonConverters.fromJson(json['sugar_address'],'AddressResponse',context!);
        sugar_phone_email = JsonConverters.fromJson(json['sugar_phone_email'],'PhoneEmailResponse',context!);
        regis_address = JsonConverters.fromJson(json['regis_address'],'AddressResponse',context!);
        regis_phone_email = JsonConverters.fromJson(json['regis_phone_email'],'PhoneEmailResponse',context!);
        re_address = JsonConverters.fromJson(json['re_address'],'AddressResponse',context!);
        re_phone_email = JsonConverters.fromJson(json['re_phone_email'],'PhoneEmailResponse',context!);
        exists_in_sugar = json['exists_in_sugar'];
        exists_in_re = json['exists_in_re'];
        are_equal = json['are_equal'];
        addr_are_equal = json['addr_are_equal'];
        city_are_equal = json['city_are_equal'];
        state_are_equal = json['state_are_equal'];
        country_are_equal = json['country_are_equal'];
        code_are_equal = json['code_are_equal'];
        phone_home_are_equal = json['phone_home_are_equal'];
        phone_cell_are_equal = json['phone_cell_are_equal'];
        phone_bus_are_equal = json['phone_bus_are_equal'];
        email_are_equal = json['email_are_equal'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'uuid': uuid,
        'regent_id': regent_id,
        'sugar_address': JsonConverters.toJson(sugar_address,'AddressResponse',context!),
        'sugar_phone_email': JsonConverters.toJson(sugar_phone_email,'PhoneEmailResponse',context!),
        'regis_address': JsonConverters.toJson(regis_address,'AddressResponse',context!),
        'regis_phone_email': JsonConverters.toJson(regis_phone_email,'PhoneEmailResponse',context!),
        're_address': JsonConverters.toJson(re_address,'AddressResponse',context!),
        're_phone_email': JsonConverters.toJson(re_phone_email,'PhoneEmailResponse',context!),
        'exists_in_sugar': exists_in_sugar,
        'exists_in_re': exists_in_re,
        'are_equal': are_equal,
        'addr_are_equal': addr_are_equal,
        'city_are_equal': city_are_equal,
        'state_are_equal': state_are_equal,
        'country_are_equal': country_are_equal,
        'code_are_equal': code_are_equal,
        'phone_home_are_equal': phone_home_are_equal,
        'phone_cell_are_equal': phone_cell_are_equal,
        'phone_bus_are_equal': phone_bus_are_equal,
        'email_are_equal': email_are_equal
    };

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

class AddressSyncRequest implements IConvertible
{
    String? uuid;

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

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

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

    getTypeName() => "AddressSyncRequest";
    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()),
    'AddressSyncResponse': TypeInfo(TypeOf.Class, create:() => AddressSyncResponse()),
    'AddressSyncRequest': TypeInfo(TypeOf.Class, create:() => AddressSyncRequest()),
});

Dart AddressSyncRequest 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/sync 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,"sugar_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"},"sugar_phone_email":{"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"},"regis_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"},"regis_phone_email":{"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"},"re_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"},"re_phone_email":{"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"},"exists_in_sugar":false,"exists_in_re":false,"are_equal":false,"addr_are_equal":false,"city_are_equal":false,"state_are_equal":false,"country_are_equal":false,"code_are_equal":false,"phone_home_are_equal":false,"phone_cell_are_equal":false,"phone_bus_are_equal":false,"email_are_equal":false}