| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /survicate/metrics |
|---|
<?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 SurvicateMetricsResponse implements JsonSerializable
{
public function __construct(
/** @description Number of distinct bookings paid via Stripe for the company. */
// @ApiMember(Description="Number of distinct bookings paid via Stripe for the company.")
/** @var int */
public int $StripePaidBookingsCount=0,
/** @description Number of distinct bookings paid via Qvickly for the company. */
// @ApiMember(Description="Number of distinct bookings paid via Qvickly for the company.")
/** @var int */
public int $QvicklyPaidBookingsCount=0,
/** @description Approximate number of bookings synced to a code lock / access control system. Derived from access-control external references (CodeLockAccessKey, IloqBookingKey); the system does not record confirmed syncs, so treat this as a proxy, not an exact count. */
// @ApiMember(Description="Approximate number of bookings synced to a code lock / access control system. Derived from access-control external references (CodeLockAccessKey, IloqBookingKey); the system does not record confirmed syncs, so treat this as a proxy, not an exact count.")
/** @var int */
public int $CodelockSyncedBookingsCount=0,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['StripePaidBookingsCount'])) $this->StripePaidBookingsCount = $o['StripePaidBookingsCount'];
if (isset($o['QvicklyPaidBookingsCount'])) $this->QvicklyPaidBookingsCount = $o['QvicklyPaidBookingsCount'];
if (isset($o['CodelockSyncedBookingsCount'])) $this->CodelockSyncedBookingsCount = $o['CodelockSyncedBookingsCount'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->StripePaidBookingsCount)) $o['StripePaidBookingsCount'] = $this->StripePaidBookingsCount;
if (isset($this->QvicklyPaidBookingsCount)) $o['QvicklyPaidBookingsCount'] = $this->QvicklyPaidBookingsCount;
if (isset($this->CodelockSyncedBookingsCount)) $o['CodelockSyncedBookingsCount'] = $this->CodelockSyncedBookingsCount;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @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")
class SurvicateMetricsQuery implements ICompany, JsonSerializable
{
public function __construct(
/** @description Enter the company id. If blank and you are an admin, your own company id is used. */
// @ApiMember(Description="Enter the company id. If blank and you are an admin, your own company id is used.", ParameterType="query")
/** @var string|null */
public ?string $CompanyId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
return empty($o) ? new class(){} : $o;
}
}
PHP SurvicateMetricsQuery 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.
GET /survicate/metrics HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SurvicateMetricsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CodelockSyncedBookingsCount>0</CodelockSyncedBookingsCount>
<QvicklyPaidBookingsCount>0</QvicklyPaidBookingsCount>
<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>
<StripePaidBookingsCount>0</StripePaidBookingsCount>
</SurvicateMetricsResponse>