| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /survicate/metrics |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
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 SurvicateMetricsQuery implements ICompany
{
/**
* 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")
public UUID CompanyId = null;
public UUID getCompanyId() { return CompanyId; }
public SurvicateMetricsQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
}
public static class SurvicateMetricsResponse
{
/**
* Number of distinct bookings paid via Stripe for the company.
*/
@ApiMember(Description="Number of distinct bookings paid via Stripe for the company.")
public Integer StripePaidBookingsCount = null;
/**
* Number of distinct bookings paid via Qvickly for the company.
*/
@ApiMember(Description="Number of distinct bookings paid via Qvickly for the company.")
public Integer QvicklyPaidBookingsCount = null;
/**
* 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.")
public Integer CodelockSyncedBookingsCount = null;
public ResponseStatus ResponseStatus = null;
public Integer getStripePaidBookingsCount() { return StripePaidBookingsCount; }
public SurvicateMetricsResponse setStripePaidBookingsCount(Integer value) { this.StripePaidBookingsCount = value; return this; }
public Integer getQvicklyPaidBookingsCount() { return QvicklyPaidBookingsCount; }
public SurvicateMetricsResponse setQvicklyPaidBookingsCount(Integer value) { this.QvicklyPaidBookingsCount = value; return this; }
public Integer getCodelockSyncedBookingsCount() { return CodelockSyncedBookingsCount; }
public SurvicateMetricsResponse setCodelockSyncedBookingsCount(Integer value) { this.CodelockSyncedBookingsCount = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public SurvicateMetricsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
Java 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: api.bookmore.com 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>