| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /survicate/metrics |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SurvicateMetricsResponse() =
///<summary>
///Number of distinct bookings paid via Stripe for the company.
///</summary>
[<ApiMember(Description="Number of distinct bookings paid via Stripe for the company.")>]
member val StripePaidBookingsCount:Int32 = new Int32() with get,set
///<summary>
///Number of distinct bookings paid via Qvickly for the company.
///</summary>
[<ApiMember(Description="Number of distinct bookings paid via Qvickly for the company.")>]
member val QvicklyPaidBookingsCount:Int32 = new Int32() with get,set
///<summary>
///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.
///</summary>
[<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.")>]
member val CodelockSyncedBookingsCount:Int32 = new Int32() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<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")>]
[<AllowNullLiteral>]
type SurvicateMetricsQuery() =
///<summary>
///Enter the company id. If blank and you are an admin, your own company id is used.
///</summary>
[<ApiMember(Description="Enter the company id. If blank and you are an admin, your own company id is used.", ParameterType="query")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
StripePaidBookingsCount: 0,
QvicklyPaidBookingsCount: 0,
CodelockSyncedBookingsCount: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}