| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /news/{Id} | Update a news item | Update a news item to the company of the currently logged in user, only administrators are allowed to update news items. |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@ValidateRequest(Validator="IsAuthenticated")
public static class UpdateNewsItem implements ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public UUID CompanyId = null;
/**
* Id of the newsitem to update
*/
@ApiMember(Description="Id of the newsitem to update", IsRequired=true, ParameterType="path")
public Integer Id = null;
/**
* The news item header, keep this short and concise
*/
@ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)
public String Heading = null;
/**
* The news body text
*/
@ApiMember(Description="The news body text", IsRequired=true)
public String Body = null;
/**
* Valid url to a image associated with the news
*/
@ApiMember(Description="Valid 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;
public UUID getCompanyId() { return CompanyId; }
public UpdateNewsItem setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public UpdateNewsItem setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public UpdateNewsItem setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public UpdateNewsItem setBody(String value) { this.Body = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public UpdateNewsItem setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public Date getFrom() { return From; }
public UpdateNewsItem setFrom(Date value) { this.From = value; return this; }
public Date getTo() { return To; }
public UpdateNewsItem setTo(Date value) { this.To = value; return this; }
}
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; }
}
}
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.
PUT /news/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateNewsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<From>0001-01-01T00:00:00</From>
<Heading>String</Heading>
<Id>0</Id>
<ImageUrl i:nil="true" />
<To>0001-01-01T00:00:00</To>
</UpdateNewsItem>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NewsItemQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<Created>0001-01-01T00:00:00</Created>
<From>0001-01-01T00:00:00</From>
<Heading>String</Heading>
<Id>0</Id>
<ImageUrl i:nil="true" />
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1: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>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1: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>
</d2p1:Meta>
</ResponseStatus>
<To>0001-01-01T00:00:00</To>
</NewsItemQueryResponse>