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 .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>