regis

<back to all web services

DirectoryBrowseRequest

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

namespace regis.ClassLibrary.Requests
{
    public partial class DirectoryBrowseRequest
    {
        public virtual int page { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class DirectoryBrowseResponse
    {
        public DirectoryBrowseResponse()
        {
            persons = new List<DirectoryPersonBrowseResponse>{};
        }

        public virtual List<DirectoryPersonBrowseResponse> persons { get; set; }
        public virtual int total_items { get; set; }
        public virtual int current_page { get; set; }
    }

    public partial class DirectoryPersonBrowseResponse
    {
        public virtual string directory_uuid { get; set; }
        public virtual string imageBase64 { get; set; }
        public virtual string name { get; set; }
        public virtual bool is_active { get; set; }
    }

}

C# 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}