regis

DirectoryBrowseRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Directory/Browse/{page}

"use strict";
export class DirectoryPersonBrowseResponse {
    /** @param {{directory_uuid?:string,imageBase64?:string,name?:string,is_active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
    /** @type {string} */
    imageBase64;
    /** @type {string} */
    name;
    /** @type {boolean} */
    is_active;
}
export class DirectoryBrowseResponse {
    /** @param {{persons?:DirectoryPersonBrowseResponse[],total_items?:number,current_page?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DirectoryPersonBrowseResponse[]} */
    persons;
    /** @type {number} */
    total_items;
    /** @type {number} */
    current_page;
}
export class DirectoryBrowseRequest {
    /** @param {{page?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    page;
}

JavaScript DirectoryBrowseRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>