| 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 java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@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")
public static class UpdateHomepageImage implements ICompany
{
/**
* Enter the company id, if blank company id and you are an admin, your company id will be used.
*/
@ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
public UUID CompanyId = null;
/**
* The homepage image id.
*/
@ApiMember(Description="The homepage image id.", IsRequired=true, ParameterType="path")
public Integer Id = null;
/**
* The image title.
*/
@ApiMember(Description="The image title.")
public String Title = null;
/**
* The image description.
*/
@ApiMember(Description="The image description.")
public String Description = null;
/**
* The image url.
*/
@ApiMember(Description="The image url.")
public Uri ImageUrl = null;
public UUID getCompanyId() { return CompanyId; }
public UpdateHomepageImage setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public UpdateHomepageImage setId(Integer value) { this.Id = value; return this; }
public String getTitle() { return Title; }
public UpdateHomepageImage setTitle(String value) { this.Title = value; return this; }
public String getDescription() { return Description; }
public UpdateHomepageImage setDescription(String value) { this.Description = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public UpdateHomepageImage setImageUrl(Uri value) { this.ImageUrl = value; return this; }
}
public static class HomepageImageQueryResponse
{
/**
* The company id.
*/
@ApiMember(Description="The company id.")
public UUID CompanyId = null;
/**
* The homepage image id.
*/
@ApiMember(Description="The homepage image id.")
public Integer Id = null;
/**
* The image title.
*/
@ApiMember(Description="The image title.")
public String Title = null;
/**
* The image description.
*/
@ApiMember(Description="The image description.")
public String Description = null;
/**
* The image url.
*/
@ApiMember(Description="The image url.")
public Uri ImageUrl = null;
public UUID getCompanyId() { return CompanyId; }
public HomepageImageQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public HomepageImageQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getTitle() { return Title; }
public HomepageImageQueryResponse setTitle(String value) { this.Title = value; return this; }
public String getDescription() { return Description; }
public HomepageImageQueryResponse setDescription(String value) { this.Description = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public HomepageImageQueryResponse setImageUrl(Uri value) { this.ImageUrl = 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 /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>