| GET | /news | Find news items for a company |
|---|
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 NewsItemQuery extends QueryDb<NewsItem, NewsItemQueryResponse>
{
/**
* Enter the company you want to see news for, if blank and you are an admin, your company id will be used
*/
@ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
public UUID CompanyId = null;
/**
* Enter the From Date you want to see news from, only allowed if admin
*/
@ApiMember(DataType="dateTime", Description="Enter the From Date you want to see news from, only allowed if admin", ParameterType="query")
public Date From = null;
/**
* Enter the To Date you want to see news to, only allowed if admin
*/
@ApiMember(DataType="dateTime", Description="Enter the To Date you want to see news to, only allowed if admin", ParameterType="query")
public Date To = null;
/**
* Use this parameter if you want to only show active news
*/
@ApiMember(DataType="boolean", Description="Use this parameter if you want to only show active news")
public Boolean Active = null;
/**
* The homeage sitepath.
*/
@ApiMember(Description="The homeage sitepath.")
public String SitePath = null;
/**
* If you want to remove Html tags from newsbody and show as plain text.
*/
@ApiMember(Description="If you want to remove Html tags from newsbody and show as plain text.")
public Boolean PlainText = null;
public UUID getCompanyId() { return CompanyId; }
public NewsItemQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Date getFrom() { return From; }
public NewsItemQuery setFrom(Date value) { this.From = value; return this; }
public Date getTo() { return To; }
public NewsItemQuery setTo(Date value) { this.To = value; return this; }
public Boolean isActive() { return Active; }
public NewsItemQuery setActive(Boolean value) { this.Active = value; return this; }
public String getSitePath() { return SitePath; }
public NewsItemQuery setSitePath(String value) { this.SitePath = value; return this; }
public Boolean isPlainText() { return PlainText; }
public NewsItemQuery setPlainText(Boolean value) { this.PlainText = 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 NewsItem extends BaseModel implements IInterval
{
@Ignore()
public Boolean Active = null;
@Required()
public UUID CompanyId = null;
public Integer Id = null;
@Required()
public String Heading = null;
@Required()
public String Body = null;
public String ImageUrl = null;
@Required()
public Date Updated = null;
@Required()
public Date Created = null;
public Date ModifiedDate = null;
@Required()
public Date From = null;
@Required()
public Date To = null;
public Boolean isActive() { return Active; }
public NewsItem setActive(Boolean value) { this.Active = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public NewsItem setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public NewsItem setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public NewsItem setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public NewsItem setBody(String value) { this.Body = value; return this; }
public String getImageUrl() { return ImageUrl; }
public NewsItem setImageUrl(String value) { this.ImageUrl = value; return this; }
public Date getUpdated() { return Updated; }
public NewsItem setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public NewsItem setCreated(Date value) { this.Created = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public NewsItem setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public Date getFrom() { return From; }
public NewsItem setFrom(Date value) { this.From = value; return this; }
public Date getTo() { return To; }
public NewsItem setTo(Date value) { this.To = value; return this; }
}
public static class BaseModel
{
}
public static class NewsItemQueryResponse
{
/**
* The news item id
*/
@ApiMember(Description="The news item id")
public Integer Id = null;
/**
* Heading of the news item
*/
@ApiMember(Description="Heading of the news item")
public String Heading = null;
/**
* Body of the news item
*/
@ApiMember(Description="Body of the news item")
public String Body = null;
/**
* Url to a image associated with the news
*/
@ApiMember(Description="Url to a image associated with the news")
public Uri ImageUrl = null;
/**
* The timestamp from which the newsitem should be visible from
*/
@ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
public Date From = null;
/**
* The timestamp to which the newsitem should be visible to
*/
@ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
public Date To = null;
/**
* The timestamp when news was created
*/
@ApiMember(Description="The timestamp when news was created", IsRequired=true)
public Date Created = null;
public ResponseStatus ResponseStatus = null;
public Integer getId() { return Id; }
public NewsItemQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public NewsItemQueryResponse setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public NewsItemQueryResponse setBody(String value) { this.Body = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public NewsItemQueryResponse setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public Date getFrom() { return From; }
public NewsItemQueryResponse setFrom(Date value) { this.From = value; return this; }
public Date getTo() { return To; }
public NewsItemQueryResponse setTo(Date value) { this.To = value; return this; }
public Date getCreated() { return Created; }
public NewsItemQueryResponse setCreated(Date value) { this.Created = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public NewsItemQueryResponse 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 /news 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,
Heading: String,
Body: String,
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
}
}
}