regis

<back to all web services

DirectoryBrowseRequest

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

export class DirectoryPersonBrowseResponse
{
    public directory_uuid: string;
    public imageBase64: string;
    public name: string;
    public is_active: boolean;

    public constructor(init?: Partial<DirectoryPersonBrowseResponse>) { (Object as any).assign(this, init); }
}

export class DirectoryBrowseResponse
{
    public persons: DirectoryPersonBrowseResponse[];
    public total_items: number;
    public current_page: number;

    public constructor(init?: Partial<DirectoryBrowseResponse>) { (Object as any).assign(this, init); }
}

export class DirectoryBrowseRequest
{
    public page: number;

    public constructor(init?: Partial<DirectoryBrowseRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
}