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

export class DirectoryShareUpdateRequest
{
    public directory_uuid: string;
    public share_full_name: boolean;
    public share_bday: boolean;
    public share_home_phone: boolean;
    public share_cell_phone: boolean;
    public share_email: boolean;
    public share_address: boolean;
    public share_quote: boolean;
    public share_bio: boolean;
    public share_interests: boolean;
    public share_home_country: boolean;
    public share_program: boolean;
    public share_picture: boolean;
    public share_spouse_name: boolean;
    public share_spouse_bday: boolean;
    public share_wedding_date: boolean;
    public share_kids: boolean;
    public share_field_of_work: boolean;
    public share_church: boolean;

    public constructor(init?: Partial<DirectoryShareUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}