| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /survicate/metrics |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.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("IsAuthenticated")]
public partial class SurvicateMetricsQuery
: ICompany
{
///<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")]
public virtual Guid? CompanyId { get; set; }
}
public partial class 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.")]
public virtual int StripePaidBookingsCount { 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.")]
public virtual int QvicklyPaidBookingsCount { 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.")]
public virtual int CodelockSyncedBookingsCount { get; set; }
public virtual ResponseStatus ResponseStatus { 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
}
}
}