regis

<back to all web services

DirectoryBrowseRequest

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

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DirectoryPersonBrowseResponse() = 
        member val directory_uuid:String = null with get,set
        member val imageBase64:String = null with get,set
        member val name:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type DirectoryBrowseResponse() = 
        member val persons:ResizeArray<DirectoryPersonBrowseResponse> = new ResizeArray<DirectoryPersonBrowseResponse>() with get,set
        member val total_items:Int32 = new Int32() with get,set
        member val current_page:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DirectoryBrowseRequest() = 
        member val page:Int32 = new Int32() with get,set

F# DirectoryBrowseRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"page":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"persons":[{"directory_uuid":"String","imageBase64":"String","name":"String","is_active":false}],"total_items":0,"current_page":0}