regis

<back to all web services

DirectoryShareUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Share/{directory_uuid}/Save
"use strict";
export class DirectoryShareUpdateRequest {
    /** @param {{directory_uuid?:string,share_full_name?:boolean,share_bday?:boolean,share_home_phone?:boolean,share_cell_phone?:boolean,share_email?:boolean,share_address?:boolean,share_quote?:boolean,share_bio?:boolean,share_interests?:boolean,share_home_country?:boolean,share_program?:boolean,share_picture?:boolean,share_spouse_name?:boolean,share_spouse_bday?:boolean,share_wedding_date?:boolean,share_kids?:boolean,share_field_of_work?:boolean,share_church?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
    /** @type {boolean} */
    share_full_name;
    /** @type {boolean} */
    share_bday;
    /** @type {boolean} */
    share_home_phone;
    /** @type {boolean} */
    share_cell_phone;
    /** @type {boolean} */
    share_email;
    /** @type {boolean} */
    share_address;
    /** @type {boolean} */
    share_quote;
    /** @type {boolean} */
    share_bio;
    /** @type {boolean} */
    share_interests;
    /** @type {boolean} */
    share_home_country;
    /** @type {boolean} */
    share_program;
    /** @type {boolean} */
    share_picture;
    /** @type {boolean} */
    share_spouse_name;
    /** @type {boolean} */
    share_spouse_bday;
    /** @type {boolean} */
    share_wedding_date;
    /** @type {boolean} */
    share_kids;
    /** @type {boolean} */
    share_field_of_work;
    /** @type {boolean} */
    share_church;
}

JavaScript DirectoryShareUpdateRequest DTOs

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

HTTP + JSV

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

POST /Directory/Share/{directory_uuid}/Save HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	directory_uuid: String,
	share_full_name: False,
	share_bday: False,
	share_home_phone: False,
	share_cell_phone: False,
	share_email: False,
	share_address: False,
	share_quote: False,
	share_bio: False,
	share_interests: False,
	share_home_country: False,
	share_program: False,
	share_picture: False,
	share_spouse_name: False,
	share_spouse_bday: False,
	share_wedding_date: False,
	share_kids: False,
	share_field_of_work: False,
	share_church: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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