| GET | /todos |
|---|
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 QueryTodos extends QueryData<Todo>
{
public Integer id = null;
public ArrayList<Long> ids = null;
public String textContains = null;
@DataMember(Order=1)
public Integer skip = null;
@DataMember(Order=2)
public Integer take = null;
@DataMember(Order=3)
public String orderBy = null;
@DataMember(Order=4)
public String orderByDesc = null;
@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 getId() { return id; }
public QueryTodos setId(Integer value) { this.id = value; return this; }
public ArrayList<Long> getIds() { return ids; }
public QueryTodos setIds(ArrayList<Long> value) { this.ids = value; return this; }
public String getTextContains() { return textContains; }
public QueryTodos setTextContains(String value) { this.textContains = value; return this; }
public Integer getSkip() { return skip; }
public QueryTodos setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public QueryTodos setTake(Integer value) { this.take = value; return this; }
public String getOrderBy() { return orderBy; }
public QueryTodos setOrderBy(String value) { this.orderBy = value; return this; }
public String getOrderByDesc() { return orderByDesc; }
public QueryTodos setOrderByDesc(String value) { this.orderByDesc = value; return this; }
public String getInclude() { return include; }
public QueryTodos setInclude(String value) { this.include = value; return this; }
public String getFields() { return fields; }
public QueryTodos setFields(String value) { this.fields = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public QueryTodos setMeta(HashMap<String,String> value) { this.meta = value; return this; }
}
public static class QueryData<T> extends QueryBase
{
@DataMember(Order=1)
public Integer skip = null;
@DataMember(Order=2)
public Integer take = null;
@DataMember(Order=3)
public String orderBy = null;
@DataMember(Order=4)
public String orderByDesc = null;
@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 QueryData<T> setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public QueryData<T> setTake(Integer value) { this.take = value; return this; }
public String getOrderBy() { return orderBy; }
public QueryData<T> setOrderBy(String value) { this.orderBy = value; return this; }
public String getOrderByDesc() { return orderByDesc; }
public QueryData<T> setOrderByDesc(String value) { this.orderByDesc = value; return this; }
public String getInclude() { return include; }
public QueryData<T> setInclude(String value) { this.include = value; return this; }
public String getFields() { return fields; }
public QueryData<T> setFields(String value) { this.fields = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public QueryData<T> setMeta(HashMap<String,String> value) { this.meta = value; return this; }
}
@DataContract
public static class QueryBase
{
@DataMember(Order=1)
public Integer skip = null;
@DataMember(Order=2)
public Integer take = null;
@DataMember(Order=3)
public String orderBy = null;
@DataMember(Order=4)
public String orderByDesc = null;
@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 Todo
{
public Long id = null;
public String text = null;
public Boolean isFinished = null;
public Long getId() { return id; }
public Todo setId(Long value) { this.id = value; return this; }
public String getText() { return text; }
public Todo setText(String value) { this.text = value; return this; }
public Boolean getIsFinished() { return isFinished; }
public Todo setIsFinished(Boolean value) { this.isFinished = value; return this; }
}
@DataContract
public static class QueryResponse<Todo>
{
@DataMember(Order=1)
public Integer offset = null;
@DataMember(Order=2)
public Integer total = null;
@DataMember(Order=3)
public ArrayList<Todo> 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<Todo> setOffset(Integer value) { this.offset = value; return this; }
public Integer getTotal() { return total; }
public QueryResponse<Todo> setTotal(Integer value) { this.total = value; return this; }
public ArrayList<Todo> getResults() { return results; }
public QueryResponse<Todo> setResults(ArrayList<Todo> value) { this.results = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public QueryResponse<Todo> setMeta(HashMap<String,String> value) { this.meta = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public QueryResponse<Todo> setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /todos HTTP/1.1 Host: vue-vite-api.jamstacks.net Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfTodotlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
<d2p1:Todo>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsFinished>false</d2p1:IsFinished>
<d2p1:Text>String</d2p1:Text>
</d2p1:Todo>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfTodotlJ4_P31p>