regis

<back to all web services

BioSyncRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/sync
"use strict";
export class BioResponse {
    /** @param {{responseStatus?:ResponseStatus,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,birth_name?:string,prefix?:string,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?:string,deceased_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    prefix;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_code;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    citizenship_other_code;
    /** @type {string} */
    permanent_resident_code;
    /** @type {string} */
    gender;
    /** @type {string} */
    gender_code;
    /** @type {string} */
    marital_status;
    /** @type {string} */
    marital_status_code;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class BioSyncResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,sugar_bio?:BioResponse,regis_bio?:BioResponse,re_bio?:BioResponse,exists_in_sugar?:boolean,exists_in_re?:boolean,are_equal?:boolean,first_name_are_equal?:boolean,middle_name_are_equal?:boolean,last_name_are_equal?:boolean,preferred_name_are_equal?:boolean,birth_name_are_equal?:boolean,prefix_are_equal?:boolean,dob_are_equal?:boolean,deceased_are_equal?:boolean,citizenship_are_equal?:boolean,gender_are_equal?:boolean,marital_status_are_equal?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {BioResponse} */
    sugar_bio;
    /** @type {BioResponse} */
    regis_bio;
    /** @type {BioResponse} */
    re_bio;
    /** @type {boolean} */
    exists_in_sugar;
    /** @type {boolean} */
    exists_in_re;
    /** @type {boolean} */
    are_equal;
    /** @type {boolean} */
    first_name_are_equal;
    /** @type {boolean} */
    middle_name_are_equal;
    /** @type {boolean} */
    last_name_are_equal;
    /** @type {boolean} */
    preferred_name_are_equal;
    /** @type {boolean} */
    birth_name_are_equal;
    /** @type {boolean} */
    prefix_are_equal;
    /** @type {boolean} */
    dob_are_equal;
    /** @type {boolean} */
    deceased_are_equal;
    /** @type {boolean} */
    citizenship_are_equal;
    /** @type {boolean} */
    gender_are_equal;
    /** @type {boolean} */
    marital_status_are_equal;
}
export class BioSyncRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript BioSyncRequest 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}/bio/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_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","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":"String","deceased_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_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","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":"String","deceased_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_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","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":"String","deceased_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,"first_name_are_equal":false,"middle_name_are_equal":false,"last_name_are_equal":false,"preferred_name_are_equal":false,"birth_name_are_equal":false,"prefix_are_equal":false,"dob_are_equal":false,"deceased_are_equal":false,"citizenship_are_equal":false,"gender_are_equal":false,"marital_status_are_equal":false}