regis

<back to all web services

AddressSyncRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/address/sync
"use strict";
export class AddressResponse {
    /** @param {{responseStatus?:ResponseStatus,addr1?:string,addr2?:string,country?:string,country_code?:string,state?:string,city?:string,code?:string,start_date?:string,end_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} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    country;
    /** @type {string} */
    country_code;
    /** @type {string} */
    state;
    /** @type {string} */
    city;
    /** @type {string} */
    code;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class PhoneEmailResponse {
    /** @param {{phone_home?:string,phone_cell?:string,phone_bus?:string,email?:string,start_date?:string,end_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    email;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class AddressSyncResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,sugar_address?:AddressResponse,sugar_phone_email?:PhoneEmailResponse,regis_address?:AddressResponse,regis_phone_email?:PhoneEmailResponse,re_address?:AddressResponse,re_phone_email?:PhoneEmailResponse,exists_in_sugar?:boolean,exists_in_re?:boolean,are_equal?:boolean,addr_are_equal?:boolean,city_are_equal?:boolean,state_are_equal?:boolean,country_are_equal?:boolean,code_are_equal?:boolean,phone_home_are_equal?:boolean,phone_cell_are_equal?:boolean,phone_bus_are_equal?:boolean,email_are_equal?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {AddressResponse} */
    sugar_address;
    /** @type {PhoneEmailResponse} */
    sugar_phone_email;
    /** @type {AddressResponse} */
    regis_address;
    /** @type {PhoneEmailResponse} */
    regis_phone_email;
    /** @type {AddressResponse} */
    re_address;
    /** @type {PhoneEmailResponse} */
    re_phone_email;
    /** @type {boolean} */
    exists_in_sugar;
    /** @type {boolean} */
    exists_in_re;
    /** @type {boolean} */
    are_equal;
    /** @type {boolean} */
    addr_are_equal;
    /** @type {boolean} */
    city_are_equal;
    /** @type {boolean} */
    state_are_equal;
    /** @type {boolean} */
    country_are_equal;
    /** @type {boolean} */
    code_are_equal;
    /** @type {boolean} */
    phone_home_are_equal;
    /** @type {boolean} */
    phone_cell_are_equal;
    /** @type {boolean} */
    phone_bus_are_equal;
    /** @type {boolean} */
    email_are_equal;
}
export class AddressSyncRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript AddressSyncRequest DTOs

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

HTTP + OTHER

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

POST /admissions/{uuid}/address/sync HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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_address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_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"},"sugar_phone_email":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_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_address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_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_phone_email":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_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_address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_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_phone_email":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_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,"addr_are_equal":false,"city_are_equal":false,"state_are_equal":false,"country_are_equal":false,"code_are_equal":false,"phone_home_are_equal":false,"phone_cell_are_equal":false,"phone_bus_are_equal":false,"email_are_equal":false}