regis

<back to all web services

SyncBioRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Bio
"use strict";
export class SyncBioAndAddressResponse {
    /** @param {{responseStatus?:ResponseStatus,successfull?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {boolean} */
    successfull;
}
export class SyncBioRequest {
    /** @param {{regent_id?:number,first_name?:string,last_name?:string,middle_name?:string,preferred_name?:string,birth_name?:string,prefix?:string,current_occupation?:string,dob?:string,deceased_date?:string,gender?:string,marital_status?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,queued_by_username?:string,queued_by_CRM?:boolean,queued_by_RE?:boolean,queued_by_REGIS?:boolean,queued_by_Sugar?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    prefix;
    /** @type {string} */
    current_occupation;
    /** @type {?string} */
    dob;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    gender;
    /** @type {string} */
    marital_status;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    queued_by_username;
    /** @type {boolean} */
    queued_by_CRM;
    /** @type {boolean} */
    queued_by_RE;
    /** @type {boolean} */
    queued_by_REGIS;
    /** @type {boolean} */
    queued_by_Sugar;
}

JavaScript SyncBioRequest 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 /Sync/Bio HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
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: 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"}},"successfull":false}