regis

<back to all web services

DirectoryBrowseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Browse/{page}
import Foundation
import ServiceStack

public class DirectoryBrowseRequest : Codable
{
    public var page:Int

    required public init(){}
}

public class DirectoryBrowseResponse : Codable
{
    public var persons:[DirectoryPersonBrowseResponse] = []
    public var total_items:Int
    public var current_page:Int

    required public init(){}
}

public class DirectoryPersonBrowseResponse : Codable
{
    public var directory_uuid:String
    public var imageBase64:String
    public var name:String
    public var is_active:Bool

    required public init(){}
}


Swift DirectoryBrowseRequest 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/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
}