regis

<back to all web services

AddressSyncUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/address/sync/update
"use strict";
export class AddressSyncUpdateRequest {
    /** @param {{authorizing_uuid?:string,uuid?:string,sugar_is_best?:boolean,regis_is_best?:boolean,re_is_best?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    uuid;
    /** @type {boolean} */
    sugar_is_best;
    /** @type {boolean} */
    regis_is_best;
    /** @type {boolean} */
    re_is_best;
}

JavaScript AddressSyncUpdateRequest 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 /admissions/{uuid}/address/sync/update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"authorizing_uuid":"String","uuid":"String","sugar_is_best":false,"regis_is_best":false,"re_is_best":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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