| 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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsItemQueryResponse:
# @ApiMember(Description="The news item id")
id: int = 0
"""
The news item id
"""
# @ApiMember(Description="Heading of the news item")
heading: Optional[str] = None
"""
Heading of the news item
"""
# @ApiMember(Description="Body of the news item")
body: Optional[str] = None
"""
Body of the news item
"""
# @ApiMember(Description="Url to a image associated with the news")
image_url: Optional[str] = None
"""
Url to a image associated with the news
"""
# @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
"""
The timestamp from which the newsitem should be visible from
"""
# @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
to: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The timestamp to which the newsitem should be visible to
"""
# @ApiMember(Description="The timestamp when news was created", IsRequired=true)
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The timestamp when news was created
"""
response_status: Optional[ResponseStatus] = None
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateNewsItem(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="Id of the newsitem to update", IsRequired=true, ParameterType="path")
id: int = 0
"""
Id of the newsitem to update
"""
# @ApiMember(Description="The news item header, keep this short and concise", IsRequired=true)
heading: Optional[str] = None
"""
The news item header, keep this short and concise
"""
# @ApiMember(Description="The news body text", IsRequired=true)
body: Optional[str] = None
"""
The news body text
"""
# @ApiMember(Description="Valid url to a image associated with the news")
image_url: Optional[str] = None
"""
Valid url to a image associated with the news
"""
# @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
"""
The timestamp from which the newsitem should be visible from
"""
# @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
to: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The timestamp to which the newsitem should be visible to
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Heading":"String","Body":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}