| 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. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class NewsItemQueryResponse
'''<Summary>
'''The news item id
'''</Summary>
<ApiMember(Description:="The news item id")>
Public Overridable Property Id As Integer
'''<Summary>
'''Heading of the news item
'''</Summary>
<ApiMember(Description:="Heading of the news item")>
Public Overridable Property Heading As String
'''<Summary>
'''Body of the news item
'''</Summary>
<ApiMember(Description:="Body of the news item")>
Public Overridable Property Body As String
'''<Summary>
'''Url to a image associated with the news
'''</Summary>
<ApiMember(Description:="Url to a image associated with the news")>
Public Overridable Property ImageUrl As Uri
'''<Summary>
'''The timestamp from which the newsitem should be visible from
'''</Summary>
<ApiMember(Description:="The timestamp from which the newsitem should be visible from", IsRequired:=true)>
Public Overridable Property From As Date
'''<Summary>
'''The timestamp to which the newsitem should be visible to
'''</Summary>
<ApiMember(Description:="The timestamp to which the newsitem should be visible to", IsRequired:=true)>
Public Overridable Property To As Date
'''<Summary>
'''The timestamp when news was created
'''</Summary>
<ApiMember(Description:="The timestamp when news was created", IsRequired:=true)>
Public Overridable Property Created As Date
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class UpdateNewsItem
Implements ICompany
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''Id of the newsitem to update
'''</Summary>
<ApiMember(Description:="Id of the newsitem to update", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As Integer
'''<Summary>
'''The news item header, keep this short and concise
'''</Summary>
<ApiMember(Description:="The news item header, keep this short and concise", IsRequired:=true)>
Public Overridable Property Heading As String
'''<Summary>
'''The news body text
'''</Summary>
<ApiMember(Description:="The news body text", IsRequired:=true)>
Public Overridable Property Body As String
'''<Summary>
'''Valid url to a image associated with the news
'''</Summary>
<ApiMember(Description:="Valid url to a image associated with the news")>
Public Overridable Property ImageUrl As Uri
'''<Summary>
'''The timestamp from which the newsitem should be visible from
'''</Summary>
<ApiMember(Description:="The timestamp from which the newsitem should be visible from", IsRequired:=true)>
Public Overridable Property From As Date
'''<Summary>
'''The timestamp to which the newsitem should be visible to
'''</Summary>
<ApiMember(Description:="The timestamp to which the newsitem should be visible to", IsRequired:=true)>
Public Overridable Property To As Date
End Class
End Namespace
End Namespace
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: api.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>