regis

<back to all web services

DirectoryBrowseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Browse/{page}
DirectoryBrowseRequest Parameters:
NameParameterData TypeRequiredDescription
pagepathintNo
DirectoryBrowseResponse Parameters:
NameParameterData TypeRequiredDescription
personsformList<DirectoryPersonBrowseResponse>No
total_itemsformintNo
current_pageformintNo
DirectoryPersonBrowseResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
imageBase64formstringNo
nameformstringNo
is_activeformboolNo

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/Browse/{page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	page: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	persons: 
	[
		{
			directory_uuid: String,
			imageBase64: String,
			name: String,
			is_active: False
		}
	],
	total_items: 0,
	current_page: 0
}