Required role: | REGISUserRole |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<DirectoryBrowseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<page>0</page>
</DirectoryBrowseRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DirectoryBrowseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <current_page>0</current_page> <persons> <DirectoryPersonBrowseResponse> <directory_uuid>String</directory_uuid> <imageBase64>String</imageBase64> <is_active>false</is_active> <name>String</name> </DirectoryPersonBrowseResponse> </persons> <total_items>0</total_items> </DirectoryBrowseResponse>