BokaMera.API.Host

SurvicateMetricsQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/survicate/metrics

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    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(Validator:="IsAuthenticated")>
        Public Partial Class SurvicateMetricsQuery
            Implements 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 Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
        End Class

        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 Overridable Property StripePaidBookingsCount As Integer

            '''<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 Overridable Property QvicklyPaidBookingsCount As Integer

            '''<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 Overridable Property CodelockSyncedBookingsCount As Integer

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET SurvicateMetricsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}