regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Settings/{uuid}
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DirectoryResponse() = 
        member val directory_uuid:String = null with get,set
        member val waiver:String = null with get,set
        member val bday:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val spouse_bday:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val spouse_name:String = null with get,set
        member val wedding_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val kids:String = null with get,set
        member val home_country:String = null with get,set
        member val quote:String = null with get,set
        member val bio:String = null with get,set
        member val interests:String = null with get,set
        member val category:String = null with get,set
        member val field_of_work:String = null with get,set
        member val church:String = null with get,set

    [<AllowNullLiteral>]
    type DirectoryShareSettingsResponse() = 
        member val directory_uuid:String = null with get,set
        member val share_full_name:Boolean = new Boolean() with get,set
        member val share_bday:Boolean = new Boolean() with get,set
        member val share_home_phone:Boolean = new Boolean() with get,set
        member val share_cell_phone:Boolean = new Boolean() with get,set
        member val share_email:Boolean = new Boolean() with get,set
        member val share_address:Boolean = new Boolean() with get,set
        member val share_quote:Boolean = new Boolean() with get,set
        member val share_bio:Boolean = new Boolean() with get,set
        member val share_interests:Boolean = new Boolean() with get,set
        member val share_home_country:Boolean = new Boolean() with get,set
        member val share_program:Boolean = new Boolean() with get,set
        member val share_picture:Boolean = new Boolean() with get,set
        member val share_spouse_name:Boolean = new Boolean() with get,set
        member val share_spouse_bday:Boolean = new Boolean() with get,set
        member val share_wedding_date:Boolean = new Boolean() with get,set
        member val share_kids:Boolean = new Boolean() with get,set
        member val share_field_of_work:Boolean = new Boolean() with get,set
        member val share_church:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type DirectoryPersonLookupResponse() = 
        member val directory_uuid:String = null with get,set
        member val name:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type DirectorySettingsAndPersonLookupResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val directory_settings:DirectoryResponse = null with get,set
        member val directory_share_settings:DirectoryShareSettingsResponse = null with get,set
        member val person_lookup:ResizeArray<DirectoryPersonLookupResponse> = new ResizeArray<DirectoryPersonLookupResponse>() with get,set

    [<AllowNullLiteral>]
    type DirectorySettingsAndActivePersonLookupRequest() = 
        member val uuid:String = null with get,set

F# DirectorySettingsAndActivePersonLookupRequest 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/Settings/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	regent_id: 0,
	uuid: String,
	directory_settings: 
	{
		directory_uuid: String,
		waiver: String,
		bday: 0001-01-01,
		spouse_bday: 0001-01-01,
		spouse_name: String,
		wedding_date: 0001-01-01,
		kids: String,
		home_country: String,
		quote: String,
		bio: String,
		interests: String,
		category: String,
		field_of_work: String,
		church: String
	},
	directory_share_settings: 
	{
		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
	},
	person_lookup: 
	[
		{
			directory_uuid: String,
			name: String,
			is_active: False
		}
	]
}