regis

<back to all web services

AddressAndBioRequest

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

class PersonExtendedResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    int? ubc_id;
    int? spouse_regent_id;
    String? uuid;
    String? regent_login;
    String? spouse_rwl;
    String? first_name;
    String? middle_name;
    String? last_name;
    String? preferred_name;
    String? birth_name;
    String? override_transcript_name;
    String? spouse_name;
    String? addr1;
    String? addr2;
    String? country;
    String? state;
    String? city;
    String? code;
    String? phone_home;
    String? phone_cell;
    String? phone_bus;
    String? email;
    String? prefix;
    DateTime? dob;
    String? citizenship;
    String? citizenship_other;
    String? permanent_resident;
    String? denomination;
    String? occupation;
    String? ethnicity;
    String? gender;
    String? marital_status;
    DateTime? deceased_date;
    bool? is_donor;
    bool? is_vendor;
    bool? is_gp_customer;
    String? crm_student_status;
    String? crm_assigned;
    String? last_registered_term;
    String? added_by;
    DateTime? added_date;
    String? last_changed_by;
    DateTime? last_changed_date;
    String? addr_last_changed_by;
    DateTime? addr_last_changed_date;
    String? tax_number;
    String? regent_current_program;
    String? regent_degrees;

    PersonExtendedResponse({this.responseStatus,this.regent_id,this.ubc_id,this.spouse_regent_id,this.uuid,this.regent_login,this.spouse_rwl,this.first_name,this.middle_name,this.last_name,this.preferred_name,this.birth_name,this.override_transcript_name,this.spouse_name,this.addr1,this.addr2,this.country,this.state,this.city,this.code,this.phone_home,this.phone_cell,this.phone_bus,this.email,this.prefix,this.dob,this.citizenship,this.citizenship_other,this.permanent_resident,this.denomination,this.occupation,this.ethnicity,this.gender,this.marital_status,this.deceased_date,this.is_donor,this.is_vendor,this.is_gp_customer,this.crm_student_status,this.crm_assigned,this.last_registered_term,this.added_by,this.added_date,this.last_changed_by,this.last_changed_date,this.addr_last_changed_by,this.addr_last_changed_date,this.tax_number,this.regent_current_program,this.regent_degrees});
    PersonExtendedResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        ubc_id = json['ubc_id'];
        spouse_regent_id = json['spouse_regent_id'];
        uuid = json['uuid'];
        regent_login = json['regent_login'];
        spouse_rwl = json['spouse_rwl'];
        first_name = json['first_name'];
        middle_name = json['middle_name'];
        last_name = json['last_name'];
        preferred_name = json['preferred_name'];
        birth_name = json['birth_name'];
        override_transcript_name = json['override_transcript_name'];
        spouse_name = json['spouse_name'];
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        country = json['country'];
        state = json['state'];
        city = json['city'];
        code = json['code'];
        phone_home = json['phone_home'];
        phone_cell = json['phone_cell'];
        phone_bus = json['phone_bus'];
        email = json['email'];
        prefix = json['prefix'];
        dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
        citizenship = json['citizenship'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        denomination = json['denomination'];
        occupation = json['occupation'];
        ethnicity = json['ethnicity'];
        gender = json['gender'];
        marital_status = json['marital_status'];
        deceased_date = JsonConverters.fromJson(json['deceased_date'],'DateTime',context!);
        is_donor = json['is_donor'];
        is_vendor = json['is_vendor'];
        is_gp_customer = json['is_gp_customer'];
        crm_student_status = json['crm_student_status'];
        crm_assigned = json['crm_assigned'];
        last_registered_term = json['last_registered_term'];
        added_by = json['added_by'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        last_changed_by = json['last_changed_by'];
        last_changed_date = JsonConverters.fromJson(json['last_changed_date'],'DateTime',context!);
        addr_last_changed_by = json['addr_last_changed_by'];
        addr_last_changed_date = JsonConverters.fromJson(json['addr_last_changed_date'],'DateTime',context!);
        tax_number = json['tax_number'];
        regent_current_program = json['regent_current_program'];
        regent_degrees = json['regent_degrees'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'ubc_id': ubc_id,
        'spouse_regent_id': spouse_regent_id,
        'uuid': uuid,
        'regent_login': regent_login,
        'spouse_rwl': spouse_rwl,
        'first_name': first_name,
        'middle_name': middle_name,
        'last_name': last_name,
        'preferred_name': preferred_name,
        'birth_name': birth_name,
        'override_transcript_name': override_transcript_name,
        'spouse_name': spouse_name,
        'addr1': addr1,
        'addr2': addr2,
        'country': country,
        'state': state,
        'city': city,
        'code': code,
        'phone_home': phone_home,
        'phone_cell': phone_cell,
        'phone_bus': phone_bus,
        'email': email,
        'prefix': prefix,
        'dob': JsonConverters.toJson(dob,'DateTime',context!),
        'citizenship': citizenship,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'denomination': denomination,
        'occupation': occupation,
        'ethnicity': ethnicity,
        'gender': gender,
        'marital_status': marital_status,
        'deceased_date': JsonConverters.toJson(deceased_date,'DateTime',context!),
        'is_donor': is_donor,
        'is_vendor': is_vendor,
        'is_gp_customer': is_gp_customer,
        'crm_student_status': crm_student_status,
        'crm_assigned': crm_assigned,
        'last_registered_term': last_registered_term,
        'added_by': added_by,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'last_changed_by': last_changed_by,
        'last_changed_date': JsonConverters.toJson(last_changed_date,'DateTime',context!),
        'addr_last_changed_by': addr_last_changed_by,
        'addr_last_changed_date': JsonConverters.toJson(addr_last_changed_date,'DateTime',context!),
        'tax_number': tax_number,
        'regent_current_program': regent_current_program,
        'regent_degrees': regent_degrees
    };

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

class PersonPictureResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? imageBase64;

    PersonPictureResponse({this.responseStatus,this.imageBase64});
    PersonPictureResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'imageBase64': imageBase64
    };

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

class CountriesAndStatesResponse implements IConvertible
{
    String? country_code;
    String? country_name;
    Map<String,String?>? states;

    CountriesAndStatesResponse({this.country_code,this.country_name,this.states});
    CountriesAndStatesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        country_code = json['country_code'];
        country_name = json['country_name'];
        states = JsonConverters.toStringMap(json['states']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'country_code': country_code,
        'country_name': country_name,
        'states': states
    };

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

class PrefixResponse implements IConvertible
{
    String? prefix_code;
    String? prefix_name;

    PrefixResponse({this.prefix_code,this.prefix_name});
    PrefixResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class Occupation implements IConvertible
{
    int? id;
    String? code;
    String? occupation_name;

    Occupation({this.id,this.code,this.occupation_name});
    Occupation.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'id': id,
        'code': code,
        'occupation_name': occupation_name
    };

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

class Denomination implements IConvertible
{
    int? id;
    String? code;
    String? denomination_name;

    Denomination({this.id,this.code,this.denomination_name});
    Denomination.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'id': id,
        'code': code,
        'denomination_name': denomination_name
    };

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

class Ethnicity implements IConvertible
{
    int? id;
    String? code;
    String? ethnicity_name;

    Ethnicity({this.id,this.code,this.ethnicity_name});
    Ethnicity.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'id': id,
        'code': code,
        'ethnicity_name': ethnicity_name
    };

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

class AddressAndBioResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    PersonExtendedResponse? person;
    PersonPictureResponse? picture;
    List<CountriesAndStatesResponse>? countriesAndStates;
    List<PrefixResponse>? prefixes;
    Map<String,String?>? maritalStatuses;
    List<Occupation>? occupations;
    List<Denomination>? denominations;
    List<Ethnicity>? ethnicities;

    AddressAndBioResponse({this.responseStatus,this.person,this.picture,this.countriesAndStates,this.prefixes,this.maritalStatuses,this.occupations,this.denominations,this.ethnicities});
    AddressAndBioResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        person = JsonConverters.fromJson(json['person'],'PersonExtendedResponse',context!);
        picture = JsonConverters.fromJson(json['picture'],'PersonPictureResponse',context!);
        countriesAndStates = JsonConverters.fromJson(json['countriesAndStates'],'List<CountriesAndStatesResponse>',context!);
        prefixes = JsonConverters.fromJson(json['prefixes'],'List<PrefixResponse>',context!);
        maritalStatuses = JsonConverters.toStringMap(json['maritalStatuses']);
        occupations = JsonConverters.fromJson(json['occupations'],'List<Occupation>',context!);
        denominations = JsonConverters.fromJson(json['denominations'],'List<Denomination>',context!);
        ethnicities = JsonConverters.fromJson(json['ethnicities'],'List<Ethnicity>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'person': JsonConverters.toJson(person,'PersonExtendedResponse',context!),
        'picture': JsonConverters.toJson(picture,'PersonPictureResponse',context!),
        'countriesAndStates': JsonConverters.toJson(countriesAndStates,'List<CountriesAndStatesResponse>',context!),
        'prefixes': JsonConverters.toJson(prefixes,'List<PrefixResponse>',context!),
        'maritalStatuses': maritalStatuses,
        'occupations': JsonConverters.toJson(occupations,'List<Occupation>',context!),
        'denominations': JsonConverters.toJson(denominations,'List<Denomination>',context!),
        'ethnicities': JsonConverters.toJson(ethnicities,'List<Ethnicity>',context!)
    };

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

class AddressAndBioRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'PersonExtendedResponse': TypeInfo(TypeOf.Class, create:() => PersonExtendedResponse()),
    'PersonPictureResponse': TypeInfo(TypeOf.Class, create:() => PersonPictureResponse()),
    'CountriesAndStatesResponse': TypeInfo(TypeOf.Class, create:() => CountriesAndStatesResponse()),
    'PrefixResponse': TypeInfo(TypeOf.Class, create:() => PrefixResponse()),
    'Occupation': TypeInfo(TypeOf.Class, create:() => Occupation()),
    'Denomination': TypeInfo(TypeOf.Class, create:() => Denomination()),
    'Ethnicity': TypeInfo(TypeOf.Class, create:() => Ethnicity()),
    'AddressAndBioResponse': TypeInfo(TypeOf.Class, create:() => AddressAndBioResponse()),
    'List<CountriesAndStatesResponse>': TypeInfo(TypeOf.Class, create:() => <CountriesAndStatesResponse>[]),
    'List<PrefixResponse>': TypeInfo(TypeOf.Class, create:() => <PrefixResponse>[]),
    'List<Occupation>': TypeInfo(TypeOf.Class, create:() => <Occupation>[]),
    'List<Denomination>': TypeInfo(TypeOf.Class, create:() => <Denomination>[]),
    'List<Ethnicity>': TypeInfo(TypeOf.Class, create:() => <Ethnicity>[]),
    'AddressAndBioRequest': TypeInfo(TypeOf.Class, create:() => AddressAndBioRequest()),
});

Dart AddressAndBioRequest 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 /person/{uuid}/addressAndBio 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"}},"person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"spouse_regent_id":0,"uuid":"String","regent_login":"String","spouse_rwl":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","override_transcript_name":"String","spouse_name":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","denomination":"String","occupation":"String","ethnicity":"String","gender":"String","marital_status":"String","deceased_date":"0001-01-01T00:00:00.0000000","is_donor":false,"is_vendor":false,"is_gp_customer":false,"crm_student_status":"String","crm_assigned":"String","last_registered_term":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","last_changed_by":"String","last_changed_date":"0001-01-01T00:00:00.0000000","addr_last_changed_by":"String","addr_last_changed_date":"0001-01-01T00:00:00.0000000","tax_number":"String","regent_current_program":"String","regent_degrees":"String"},"picture":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"imageBase64":"String"},"countriesAndStates":[{"country_code":"String","country_name":"String","states":{"String":"String"}}],"prefixes":[{"prefix_code":"String","prefix_name":"String"}],"maritalStatuses":{"String":"String"},"occupations":[{"id":0,"code":"String","occupation_name":"String"}],"denominations":[{"id":0,"code":"String","denomination_name":"String"}],"ethnicities":[{"id":0,"code":"String","ethnicity_name":"String"}]}