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

public class dtos
{

    public static class DirectoryBrowseRequest
    {
        public Integer page = null;
        
        public Integer getPage() { return page; }
        public DirectoryBrowseRequest setPage(Integer value) { this.page = value; return this; }
    }

    public static class DirectoryBrowseResponse
    {
        public ArrayList<DirectoryPersonBrowseResponse> persons = null;
        public Integer total_items = null;
        public Integer current_page = null;
        
        public ArrayList<DirectoryPersonBrowseResponse> getPersons() { return persons; }
        public DirectoryBrowseResponse setPersons(ArrayList<DirectoryPersonBrowseResponse> value) { this.persons = value; return this; }
        public Integer getTotalItems() { return total_items; }
        public DirectoryBrowseResponse setTotalItems(Integer value) { this.total_items = value; return this; }
        public Integer getCurrentPage() { return current_page; }
        public DirectoryBrowseResponse setCurrentPage(Integer value) { this.current_page = value; return this; }
    }

    public static class DirectoryPersonBrowseResponse
    {
        public String directory_uuid = null;
        public String imageBase64 = null;
        public String name = null;
        public Boolean is_active = null;
        
        public String getDirectoryUuid() { return directory_uuid; }
        public DirectoryPersonBrowseResponse setDirectoryUuid(String value) { this.directory_uuid = value; return this; }
        public String getImageBase64() { return imageBase64; }
        public DirectoryPersonBrowseResponse setImageBase64(String value) { this.imageBase64 = value; return this; }
        public String getName() { return name; }
        public DirectoryPersonBrowseResponse setName(String value) { this.name = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public DirectoryPersonBrowseResponse setIsActive(Boolean value) { this.is_active = value; return this; }
    }

}

Java DirectoryBrowseRequest DTOs

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

HTTP + OTHER

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

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

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