regis

BioHistoryRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import 'package:servicestack/servicestack.dart';

class BioResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? first_name;
    String? middle_name;
    String? last_name;
    String? preferred_name;
    String? birth_name;
    String? prefix;
    DateTime? dob;
    String? citizenship;
    String? citizenship_code;
    String? citizenship_other;
    String? permanent_resident;
    String? citizenship_other_code;
    String? permanent_resident_code;
    String? gender;
    String? gender_code;
    String? marital_status;
    String? marital_status_code;
    DateTime? deceased_date;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;

    BioResponse({this.responseStatus,this.first_name,this.middle_name,this.last_name,this.preferred_name,this.birth_name,this.prefix,this.dob,this.citizenship,this.citizenship_code,this.citizenship_other,this.permanent_resident,this.citizenship_other_code,this.permanent_resident_code,this.gender,this.gender_code,this.marital_status,this.marital_status_code,this.deceased_date,this.added_by,this.added_date,this.changed_by,this.changed_date});
    BioResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        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'];
        prefix = json['prefix'];
        dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
        citizenship = json['citizenship'];
        citizenship_code = json['citizenship_code'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        citizenship_other_code = json['citizenship_other_code'];
        permanent_resident_code = json['permanent_resident_code'];
        gender = json['gender'];
        gender_code = json['gender_code'];
        marital_status = json['marital_status'];
        marital_status_code = json['marital_status_code'];
        deceased_date = JsonConverters.fromJson(json['deceased_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!),
        'first_name': first_name,
        'middle_name': middle_name,
        'last_name': last_name,
        'preferred_name': preferred_name,
        'birth_name': birth_name,
        'prefix': prefix,
        'dob': JsonConverters.toJson(dob,'DateTime',context!),
        'citizenship': citizenship,
        'citizenship_code': citizenship_code,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'citizenship_other_code': citizenship_other_code,
        'permanent_resident_code': permanent_resident_code,
        'gender': gender,
        'gender_code': gender_code,
        'marital_status': marital_status,
        'marital_status_code': marital_status_code,
        'deceased_date': JsonConverters.toJson(deceased_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() => "BioResponse";
    TypeContext? context = _ctx;
}

class BioHistoryResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    int? regent_id;
    List<BioResponse>? bios;

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

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

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

class BioHistoryRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'BioResponse': TypeInfo(TypeOf.Class, create:() => BioResponse()),
    'BioHistoryResponse': TypeInfo(TypeOf.Class, create:() => BioHistoryResponse()),
    'List<BioResponse>': TypeInfo(TypeOf.Class, create:() => <BioResponse>[]),
    'BioHistoryRequest': TypeInfo(TypeOf.Class, create:() => BioHistoryRequest()),
});

Dart BioHistoryRequest 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}/bio/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<BioHistoryResponse 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>
  <bios>
    <BioResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <birth_name>String</birth_name>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <citizenship>String</citizenship>
      <citizenship_code>String</citizenship_code>
      <citizenship_other>String</citizenship_other>
      <citizenship_other_code>String</citizenship_other_code>
      <deceased_date>0001-01-01T00:00:00</deceased_date>
      <dob>0001-01-01T00:00:00</dob>
      <first_name>String</first_name>
      <gender>String</gender>
      <gender_code>String</gender_code>
      <last_name>String</last_name>
      <marital_status>String</marital_status>
      <marital_status_code>String</marital_status_code>
      <middle_name>String</middle_name>
      <permanent_resident>String</permanent_resident>
      <permanent_resident_code>String</permanent_resident_code>
      <preferred_name>String</preferred_name>
      <prefix>String</prefix>
    </BioResponse>
  </bios>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</BioHistoryResponse>