regis

<back to all web services

DirectoryBrowseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Browse/{page}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class DirectoryBrowseRequest
            Public Overridable Property page As Integer
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class DirectoryBrowseResponse
            Public Sub New()
                persons = New List(Of DirectoryPersonBrowseResponse)
            End Sub

            Public Overridable Property persons As List(Of DirectoryPersonBrowseResponse)
            Public Overridable Property total_items As Integer
            Public Overridable Property current_page As Integer
        End Class

        Public Partial Class DirectoryPersonBrowseResponse
            Public Overridable Property directory_uuid As String
            Public Overridable Property imageBase64 As String
            Public Overridable Property name As String
            Public Overridable Property is_active As Boolean
        End Class
    End Namespace
End Namespace

VB.NET DirectoryBrowseRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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