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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DirectoryShareUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <directory_uuid>String</directory_uuid>
  <share_address>false</share_address>
  <share_bday>false</share_bday>
  <share_bio>false</share_bio>
  <share_cell_phone>false</share_cell_phone>
  <share_church>false</share_church>
  <share_email>false</share_email>
  <share_field_of_work>false</share_field_of_work>
  <share_full_name>false</share_full_name>
  <share_home_country>false</share_home_country>
  <share_home_phone>false</share_home_phone>
  <share_interests>false</share_interests>
  <share_kids>false</share_kids>
  <share_picture>false</share_picture>
  <share_program>false</share_program>
  <share_quote>false</share_quote>
  <share_spouse_bday>false</share_spouse_bday>
  <share_spouse_name>false</share_spouse_name>
  <share_wedding_date>false</share_wedding_date>
</DirectoryShareUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>