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 Foundation
import ServiceStack
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateNewsItem : ICompany, Codable
{
/**
* 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 var companyId:String?
/**
* Id of the newsitem to update
*/
// @ApiMember(Description="Id of the newsitem to update", IsRequired=true, ParameterType="path")
public var id:Int
/**
* The news item header, keep this short and concise
*/
// @ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)
public var heading:String
/**
* The news body text
*/
// @ApiMember(Description="The news body text", IsRequired=true)
public var body:String
/**
* Valid url to a image associated with the news
*/
// @ApiMember(Description="Valid url to a image associated with the news")
public var imageUrl:Uri
/**
* 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 var from:Date
/**
* 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 var to:Date
required public init(){}
}
public class NewsItemQueryResponse : Codable
{
/**
* The news item id
*/
// @ApiMember(Description="The news item id")
public var id:Int
/**
* Heading of the news item
*/
// @ApiMember(Description="Heading of the news item")
public var heading:String
/**
* Body of the news item
*/
// @ApiMember(Description="Body of the news item")
public var body:String
/**
* Url to a image associated with the news
*/
// @ApiMember(Description="Url to a image associated with the news")
public var imageUrl:Uri
/**
* 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 var from:Date
/**
* 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 var to:Date
/**
* The timestamp when news was created
*/
// @ApiMember(Description="The timestamp when news was created", IsRequired=true)
public var created:Date
public var responseStatus:ResponseStatus
required public init(){}
}
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.
PUT /news/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
Heading: String,
Body: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 } } }