Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /homepage/images/{Id} | Update a homepage image | Update a homepage image to the company of the currently logged in user, only administrators are allowed to add support cases. |
---|
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 HomepageImageQueryResponse:
# @ApiMember(Description="The company id.")
company_id: Optional[str] = None
"""
The company id.
"""
# @ApiMember(Description="The homepage image id.")
id: int = 0
"""
The homepage image id.
"""
# @ApiMember(Description="The image title.")
title: Optional[str] = None
"""
The image title.
"""
# @ApiMember(Description="The image description.")
description: Optional[str] = None
"""
The image description.
"""
# @ApiMember(Description="The image url.")
image_url: Optional[str] = None
"""
The image url.
"""
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateHomepageImage(ICompany):
# @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
company_id: Optional[str] = None
"""
Enter the company id, if blank company id and you are an admin, your company id will be used.
"""
# @ApiMember(Description="The homepage image id.", IsRequired=true, ParameterType="path")
id: int = 0
"""
The homepage image id.
"""
# @ApiMember(Description="The image title.")
title: Optional[str] = None
"""
The image title.
"""
# @ApiMember(Description="The image description.")
description: Optional[str] = None
"""
The image description.
"""
# @ApiMember(Description="The image url.")
image_url: Optional[str] = None
"""
The image url.
"""
Python UpdateHomepageImage DTOs
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 /homepage/images/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateHomepageImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Description>String</Description>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Title>String</Title>
</UpdateHomepageImage>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <HomepageImageQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Description>String</Description> <Id>0</Id> <ImageUrl i:nil="true" /> <Title>String</Title> </HomepageImageQueryResponse>