BokaMera.API.Host

<back to all web services

CreateAxemaUserSync

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/codelock/axema/usersyncStart a sync of users from the Axema Vaka system into BokaMera customersThis operation runs in the background and may take several minutes. Use the GET endpoint to check status. Only one sync can run at a time per company.
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

        Public Partial Class AxemaUserSyncJobResponse
            Public Overridable Property Id As Guid
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Status As Integer
            Public Overridable Property StatusName As String
            Public Overridable Property UsersFound As Integer?
            Public Overridable Property UsersCreated As Integer?
            Public Overridable Property UsersUpdated As Integer?
            Public Overridable Property ErrorMessage As String
            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As Date
        End Class

        <ValidateRequest(Validator:="IsAuthenticated")>
        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privileges to call this service", StatusCode:=403)>
        Public Partial Class CreateAxemaUserSync
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
        End Class
    End Namespace
End Namespace

VB.NET CreateAxemaUserSync DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /codelock/axema/usersync HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Status":0,"StatusName":"String","UsersFound":0,"UsersCreated":0,"UsersUpdated":0,"ErrorMessage":"String"}