regis

<back to all web services

SyncBioRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Bio
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class SyncBioAndAddressResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    bool? successfull;

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

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

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

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

class SyncBioRequest implements IConvertible
{
    int? regent_id;
    String? first_name;
    String? last_name;
    String? middle_name;
    String? preferred_name;
    String? birth_name;
    String? prefix;
    String? current_occupation;
    DateTime? dob;
    DateTime? deceased_date;
    String? gender;
    String? marital_status;
    String? citizenship;
    String? citizenship_other;
    String? permanent_resident;
    String? queued_by_username;
    bool? queued_by_CRM;
    bool? queued_by_RE;
    bool? queued_by_REGIS;
    bool? queued_by_Sugar;

    SyncBioRequest({this.regent_id,this.first_name,this.last_name,this.middle_name,this.preferred_name,this.birth_name,this.prefix,this.current_occupation,this.dob,this.deceased_date,this.gender,this.marital_status,this.citizenship,this.citizenship_other,this.permanent_resident,this.queued_by_username,this.queued_by_CRM,this.queued_by_RE,this.queued_by_REGIS,this.queued_by_Sugar});
    SyncBioRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        middle_name = json['middle_name'];
        preferred_name = json['preferred_name'];
        birth_name = json['birth_name'];
        prefix = json['prefix'];
        current_occupation = json['current_occupation'];
        dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
        deceased_date = JsonConverters.fromJson(json['deceased_date'],'DateTime',context!);
        gender = json['gender'];
        marital_status = json['marital_status'];
        citizenship = json['citizenship'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        queued_by_username = json['queued_by_username'];
        queued_by_CRM = json['queued_by_CRM'];
        queued_by_RE = json['queued_by_RE'];
        queued_by_REGIS = json['queued_by_REGIS'];
        queued_by_Sugar = json['queued_by_Sugar'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'middle_name': middle_name,
        'preferred_name': preferred_name,
        'birth_name': birth_name,
        'prefix': prefix,
        'current_occupation': current_occupation,
        'dob': JsonConverters.toJson(dob,'DateTime',context!),
        'deceased_date': JsonConverters.toJson(deceased_date,'DateTime',context!),
        'gender': gender,
        'marital_status': marital_status,
        'citizenship': citizenship,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'queued_by_username': queued_by_username,
        'queued_by_CRM': queued_by_CRM,
        'queued_by_RE': queued_by_RE,
        'queued_by_REGIS': queued_by_REGIS,
        'queued_by_Sugar': queued_by_Sugar
    };

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'SyncBioAndAddressResponse': TypeInfo(TypeOf.Class, create:() => SyncBioAndAddressResponse()),
    'SyncBioRequest': TypeInfo(TypeOf.Class, create:() => SyncBioRequest()),
});

Dart SyncBioRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Sync/Bio HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"regent_id":0,"first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","current_occupation":"String","dob":"0001-01-01T00:00:00.0000000","deceased_date":"0001-01-01T00:00:00.0000000","gender":"String","marital_status":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","queued_by_username":"String","queued_by_CRM":false,"queued_by_RE":false,"queued_by_REGIS":false,"queued_by_Sugar":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"successfull":false}