| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /widget/configuration/{Id}/sethomepage | Set a widget configuration as the homepage default | Makes the supplied configuration the company's homepage default and removes the flag from the previous one. Slugs are left unchanged. Calling it on the current homepage default is a no-op success. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class WidgetConfigurationResponse implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $CompanyId='',
/** @var string */
public string $Name='',
/** @var string|null */
public ?string $Slug=null,
/** @var string|null */
public ?string $Description=null,
/** @var string */
public string $Configuration='',
/** @var int */
public int $SchemaVersion=0,
/** @var bool|null */
public ?bool $IsHomepageDefault=null,
/** @var DateTime */
public DateTime $CreatedDate=new DateTime(),
/** @var DateTime|null */
public ?DateTime $UpdatedDate=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Slug'])) $this->Slug = $o['Slug'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Configuration'])) $this->Configuration = $o['Configuration'];
if (isset($o['SchemaVersion'])) $this->SchemaVersion = $o['SchemaVersion'];
if (isset($o['IsHomepageDefault'])) $this->IsHomepageDefault = $o['IsHomepageDefault'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
if (isset($o['UpdatedDate'])) $this->UpdatedDate = JsonConverters::from('DateTimeOffset', $o['UpdatedDate']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Slug)) $o['Slug'] = $this->Slug;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Configuration)) $o['Configuration'] = $this->Configuration;
if (isset($this->SchemaVersion)) $o['SchemaVersion'] = $this->SchemaVersion;
if (isset($this->IsHomepageDefault)) $o['IsHomepageDefault'] = $this->IsHomepageDefault;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
if (isset($this->UpdatedDate)) $o['UpdatedDate'] = JsonConverters::to('DateTimeOffset', $this->UpdatedDate);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the configuration was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class SetHomepageWidgetConfiguration implements ICompany, JsonSerializable
{
public function __construct(
/** @description 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.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description The widget configuration id (6-character NanoID). */
// @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
/** @var string */
public string $Id=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
PHP SetHomepageWidgetConfiguration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /widget/configuration/{Id}/sethomepage HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"IsHomepageDefault":false,"UpdatedDate":"0001-01-01T00:00:00.0000000+00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}