regis

PersonBaseValuesRequest

**Requires Authentication**
Required permission:	ReadPersonBaseValues

The following routes are available for this service:
POST	/person/baseValues

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

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;
    bool? is_regent_staff;
    String? regent_title;
    String? regent_department;
    String? regent_faculty_profile_url;
    String? regent_image_url;
    bool? include_on_website;
    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.is_regent_staff,this.regent_title,this.regent_department,this.regent_faculty_profile_url,this.regent_image_url,this.include_on_website,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'];
        is_regent_staff = json['is_regent_staff'];
        regent_title = json['regent_title'];
        regent_department = json['regent_department'];
        regent_faculty_profile_url = json['regent_faculty_profile_url'];
        regent_image_url = json['regent_image_url'];
        include_on_website = json['include_on_website'];
        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,
        'is_regent_staff': is_regent_staff,
        'regent_title': regent_title,
        'regent_department': regent_department,
        'regent_faculty_profile_url': regent_faculty_profile_url,
        'regent_image_url': regent_image_url,
        'include_on_website': include_on_website,
        '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 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 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 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 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 PersonBaseValuesResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    PersonExtendedResponse? person;
    List<CountriesAndStatesResponse>? countriesAndStates;
    List<PrefixResponse>? prefixes;
    Map<String,String?>? maritalStatuses;
    List<Denomination>? denominations;
    List<Occupation>? occupations;
    List<Ethnicity>? ethnicities;

    PersonBaseValuesResponse({this.responseStatus,this.person,this.countriesAndStates,this.prefixes,this.maritalStatuses,this.denominations,this.occupations,this.ethnicities});
    PersonBaseValuesResponse.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!);
        countriesAndStates = JsonConverters.fromJson(json['countriesAndStates'],'List<CountriesAndStatesResponse>',context!);
        prefixes = JsonConverters.fromJson(json['prefixes'],'List<PrefixResponse>',context!);
        maritalStatuses = JsonConverters.toStringMap(json['maritalStatuses']);
        denominations = JsonConverters.fromJson(json['denominations'],'List<Denomination>',context!);
        occupations = JsonConverters.fromJson(json['occupations'],'List<Occupation>',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!),
        'countriesAndStates': JsonConverters.toJson(countriesAndStates,'List<CountriesAndStatesResponse>',context!),
        'prefixes': JsonConverters.toJson(prefixes,'List<PrefixResponse>',context!),
        'maritalStatuses': maritalStatuses,
        'denominations': JsonConverters.toJson(denominations,'List<Denomination>',context!),
        'occupations': JsonConverters.toJson(occupations,'List<Occupation>',context!),
        'ethnicities': JsonConverters.toJson(ethnicities,'List<Ethnicity>',context!)
    };

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

class PersonBaseValuesRequest implements IConvertible
{
    PersonBaseValuesRequest();
    PersonBaseValuesRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PersonBaseValuesRequest";
    TypeContext? context = _ctx;
}

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

Dart PersonBaseValuesRequest 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 /person/baseValues HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonBaseValuesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PersonBaseValuesResponse 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>
  <countriesAndStates>
    <CountriesAndStatesResponse>
      <country_code>String</country_code>
      <country_name>String</country_name>
      <states xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </states>
    </CountriesAndStatesResponse>
  </countriesAndStates>
  <denominations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Denomination>
      <d2p1:code>String</d2p1:code>
      <d2p1:denomination_name>String</d2p1:denomination_name>
      <d2p1:id>0</d2p1:id>
    </d2p1:Denomination>
  </denominations>
  <ethnicities xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Ethnicity>
      <d2p1:code>String</d2p1:code>
      <d2p1:ethnicity_name>String</d2p1:ethnicity_name>
      <d2p1:id>0</d2p1:id>
    </d2p1:Ethnicity>
  </ethnicities>
  <maritalStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </maritalStatuses>
  <occupations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Occupation>
      <d2p1:code>String</d2p1:code>
      <d2p1:id>0</d2p1:id>
      <d2p1:occupation_name>String</d2p1:occupation_name>
    </d2p1:Occupation>
  </occupations>
  <person>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1: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>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <addr_last_changed_by>String</addr_last_changed_by>
    <addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date>
    <birth_name>String</birth_name>
    <citizenship>String</citizenship>
    <citizenship_other>String</citizenship_other>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <crm_assigned>String</crm_assigned>
    <crm_student_status>String</crm_student_status>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <denomination>String</denomination>
    <dob>0001-01-01T00:00:00</dob>
    <email>String</email>
    <ethnicity>String</ethnicity>
    <first_name>String</first_name>
    <gender>String</gender>
    <include_on_website>false</include_on_website>
    <is_donor>false</is_donor>
    <is_gp_customer>false</is_gp_customer>
    <is_regent_staff>false</is_regent_staff>
    <is_vendor>false</is_vendor>
    <last_changed_by>String</last_changed_by>
    <last_changed_date>0001-01-01T00:00:00</last_changed_date>
    <last_name>String</last_name>
    <last_registered_term>String</last_registered_term>
    <marital_status>String</marital_status>
    <middle_name>String</middle_name>
    <occupation>String</occupation>
    <override_transcript_name>String</override_transcript_name>
    <permanent_resident>String</permanent_resident>
    <phone_bus>String</phone_bus>
    <phone_cell>String</phone_cell>
    <phone_home>String</phone_home>
    <preferred_name>String</preferred_name>
    <prefix>String</prefix>
    <regent_current_program>String</regent_current_program>
    <regent_degrees>String</regent_degrees>
    <regent_department>String</regent_department>
    <regent_faculty_profile_url>String</regent_faculty_profile_url>
    <regent_id>0</regent_id>
    <regent_image_url>String</regent_image_url>
    <regent_login>String</regent_login>
    <regent_title>String</regent_title>
    <spouse_name>String</spouse_name>
    <spouse_regent_id>0</spouse_regent_id>
    <spouse_rwl>String</spouse_rwl>
    <state>String</state>
    <tax_number>String</tax_number>
    <ubc_id>0</ubc_id>
    <uuid>String</uuid>
  </person>
  <prefixes>
    <PrefixResponse>
      <prefix_code>String</prefix_code>
      <prefix_name>String</prefix_name>
    </PrefixResponse>
  </prefixes>
</PersonBaseValuesResponse>