regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Settings/{uuid}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class DirectorySettingsAndActivePersonLookupRequest
{
    var uuid:String? = null
}

open class DirectorySettingsAndPersonLookupResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var directory_settings:DirectoryResponse? = null
    var directory_share_settings:DirectoryShareSettingsResponse? = null
    var person_lookup:ArrayList<DirectoryPersonLookupResponse> = ArrayList<DirectoryPersonLookupResponse>()
}

open class DirectoryResponse
{
    var directory_uuid:String? = null
    var waiver:String? = null
    var bday:Date? = null
    var spouse_bday:Date? = null
    var spouse_name:String? = null
    var wedding_date:Date? = null
    var kids:String? = null
    var home_country:String? = null
    var quote:String? = null
    var bio:String? = null
    var interests:String? = null
    var category:String? = null
    var field_of_work:String? = null
    var church:String? = null
}

open class DirectoryShareSettingsResponse
{
    var directory_uuid:String? = null
    var share_full_name:Boolean? = null
    var share_bday:Boolean? = null
    var share_home_phone:Boolean? = null
    var share_cell_phone:Boolean? = null
    var share_email:Boolean? = null
    var share_address:Boolean? = null
    var share_quote:Boolean? = null
    var share_bio:Boolean? = null
    var share_interests:Boolean? = null
    var share_home_country:Boolean? = null
    var share_program:Boolean? = null
    var share_picture:Boolean? = null
    var share_spouse_name:Boolean? = null
    var share_spouse_bday:Boolean? = null
    var share_wedding_date:Boolean? = null
    var share_kids:Boolean? = null
    var share_field_of_work:Boolean? = null
    var share_church:Boolean? = null
}

open class DirectoryPersonLookupResponse
{
    var directory_uuid:String? = null
    var name:String? = null
    var is_active:Boolean? = null
}

Kotlin 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
		}
	]
}