regis

<back to all web services

DirectoryBrowseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Browse/{page}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class DirectoryBrowseRequest
{
    var page:Int? = null
}

open class DirectoryBrowseResponse
{
    var persons:ArrayList<DirectoryPersonBrowseResponse> = ArrayList<DirectoryPersonBrowseResponse>()
    var total_items:Int? = null
    var current_page:Int? = null
}

open class DirectoryPersonBrowseResponse
{
    var directory_uuid:String? = null
    var imageBase64:String? = null
    var name:String? = null
    var is_active:Boolean? = null
}

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