Billiecart API

<back to all web services

ListMembersForOrganisationRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/organisations/{Id}/members
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ListMembersForOrganisationRequest extends SearchOperationUnTenanted<ListMembersForOrganisationResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public ListMembersForOrganisationRequest setId(String value) { this.id = value; return this; }
    }

    public static class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
    {
        public String distinct = null;
        public Integer limit = null;
        public Integer offset = null;
        public String sort = null;
        public String filter = null;
        public String search = null;
        
        public String getDistinct() { return distinct; }
        public SearchOperationUnTenanted<TResponse> setDistinct(String value) { this.distinct = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchOperationUnTenanted<TResponse> setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchOperationUnTenanted<TResponse> setOffset(Integer value) { this.offset = value; return this; }
        public String getSort() { return sort; }
        public SearchOperationUnTenanted<TResponse> setSort(String value) { this.sort = value; return this; }
        public String getFilter() { return filter; }
        public SearchOperationUnTenanted<TResponse> setFilter(String value) { this.filter = value; return this; }
        public String getSearch() { return search; }
        public SearchOperationUnTenanted<TResponse> setSearch(String value) { this.search = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class ListMembersForOrganisationResponse extends SearchOperationResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<OrganisationMembership> members = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ListMembersForOrganisationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<OrganisationMembership> getMembers() { return members; }
        public ListMembersForOrganisationResponse setMembers(ArrayList<OrganisationMembership> value) { this.members = value; return this; }
    }

    public static class SearchOperationResponse
    {
        public SearchMetadata metadata = null;
        
        public SearchMetadata getMetadata() { return metadata; }
        public SearchOperationResponse setMetadata(SearchMetadata value) { this.metadata = value; return this; }
    }

    public static class SearchMetadata
    {
        public Integer total = null;
        public Integer limit = null;
        public Integer offset = null;
        public Sorting sort = null;
        public Filtering filter = null;
        
        public Integer getTotal() { return total; }
        public SearchMetadata setTotal(Integer value) { this.total = value; return this; }
        public Integer getLimit() { return limit; }
        public SearchMetadata setLimit(Integer value) { this.limit = value; return this; }
        public Integer getOffset() { return offset; }
        public SearchMetadata setOffset(Integer value) { this.offset = value; return this; }
        public Sorting getSort() { return sort; }
        public SearchMetadata setSort(Sorting value) { this.sort = value; return this; }
        public Filtering getFilter() { return filter; }
        public SearchMetadata setFilter(Filtering value) { this.filter = value; return this; }
    }

    public static class Sorting
    {
        public String by = null;
        public SortDirection direction = null;
        
        public String getBy() { return by; }
        public Sorting setBy(String value) { this.by = value; return this; }
        public SortDirection getDirection() { return direction; }
        public Sorting setDirection(SortDirection value) { this.direction = value; return this; }
    }

    public static enum SortDirection
    {
        Ascending,
        Descending;
    }

    public static class Filtering
    {
        public ArrayList<String> fields = null;
        public String search = null;
        
        public ArrayList<String> getFields() { return fields; }
        public Filtering setFields(ArrayList<String> value) { this.fields = value; return this; }
        public String getSearch() { return search; }
        public Filtering setSearch(String value) { this.search = value; return this; }
    }

    public static class OrganisationMembership implements IIdentifiableResource
    {
        public String emailAddress = null;
        public Boolean isOwner = null;
        public Boolean isConfirmed = null;
        public String id = null;
        
        public String getEmailAddress() { return emailAddress; }
        public OrganisationMembership setEmailAddress(String value) { this.emailAddress = value; return this; }
        public Boolean getIsOwner() { return isOwner; }
        public OrganisationMembership setIsOwner(Boolean value) { this.isOwner = value; return this; }
        public Boolean getIsConfirmed() { return isConfirmed; }
        public OrganisationMembership setIsConfirmed(Boolean value) { this.isConfirmed = value; return this; }
        public String getId() { return id; }
        public OrganisationMembership setId(String value) { this.id = value; return this; }
    }

}

Java ListMembersForOrganisationRequest 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.

GET /organisations/{Id}/members HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"members":[{"emailAddress":"String","isOwner":false,"isConfirmed":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}