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 Foundation
import ServiceStack

public class DirectorySettingsAndActivePersonLookupRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class DirectorySettingsAndPersonLookupResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var directory_settings:DirectoryResponse
    public var directory_share_settings:DirectoryShareSettingsResponse
    public var person_lookup:[DirectoryPersonLookupResponse] = []

    required public init(){}
}

public class DirectoryResponse : Codable
{
    public var directory_uuid:String
    public var waiver:String
    public var bday:Date?
    public var spouse_bday:Date?
    public var spouse_name:String
    public var wedding_date:Date?
    public var kids:String
    public var home_country:String
    public var quote:String
    public var bio:String
    public var interests:String
    public var category:String
    public var field_of_work:String
    public var church:String

    required public init(){}
}

public class DirectoryShareSettingsResponse : Codable
{
    public var directory_uuid:String
    public var share_full_name:Bool
    public var share_bday:Bool
    public var share_home_phone:Bool
    public var share_cell_phone:Bool
    public var share_email:Bool
    public var share_address:Bool
    public var share_quote:Bool
    public var share_bio:Bool
    public var share_interests:Bool
    public var share_home_country:Bool
    public var share_program:Bool
    public var share_picture:Bool
    public var share_spouse_name:Bool
    public var share_spouse_bday:Bool
    public var share_wedding_date:Bool
    public var share_kids:Bool
    public var share_field_of_work:Bool
    public var share_church:Bool

    required public init(){}
}

public class DirectoryPersonLookupResponse : Codable
{
    public var directory_uuid:String
    public var name:String
    public var is_active:Bool

    required public init(){}
}


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