| GET | /categories | Find service categories | Find service categories that a company can belong to. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
public static class CategoryQuery extends QueryDb<CompanyCategory, CategoryQueryResponse>
{
/**
* Id of the category
*/
@ApiMember(Description="Id of the category")
public Integer Id = null;
public Integer getId() { return Id; }
public CategoryQuery setId(Integer value) { this.Id = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
public Integer Skip = null;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
public Integer Take = null;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
public String OrderBy = null;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
public String OrderByDesc = null;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class CompanyCategory extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String Header = null;
@Required()
public String Description = null;
public Uri ImageUrl = null;
@Required()
public Boolean Active = null;
public Integer SortOrder = null;
public Date ModifiedDate = null;
public Integer Id = null;
public String getName() { return Name; }
public CompanyCategory setName(String value) { this.Name = value; return this; }
public String getHeader() { return Header; }
public CompanyCategory setHeader(String value) { this.Header = value; return this; }
public String getDescription() { return Description; }
public CompanyCategory setDescription(String value) { this.Description = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public CompanyCategory setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public Boolean isActive() { return Active; }
public CompanyCategory setActive(Boolean value) { this.Active = value; return this; }
public Integer getSortOrder() { return SortOrder; }
public CompanyCategory setSortOrder(Integer value) { this.SortOrder = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public CompanyCategory setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public Integer getId() { return Id; }
public CompanyCategory setId(Integer value) { this.Id = value; return this; }
}
public static class BaseModel
{
}
public static class CategoryQueryResponse
{
public Integer Id = null;
public String Name = null;
public String Description = null;
public String Header = null;
public Uri ImageUrl = null;
public Boolean Active = null;
public ResponseStatus ResponseStatus = null;
public Integer getId() { return Id; }
public CategoryQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public CategoryQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public CategoryQueryResponse setDescription(String value) { this.Description = value; return this; }
public String getHeader() { return Header; }
public CategoryQueryResponse setHeader(String value) { this.Header = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public CategoryQueryResponse setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public Boolean isActive() { return Active; }
public CategoryQueryResponse setActive(Boolean value) { this.Active = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public CategoryQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
@DataContract
public static class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /categories HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Name: String,
Description: String,
Header: String,
Active: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}