BokaMera.API.Host

QueryAxemaUserSyncJobs

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

The following routes are available for this service:
GET	/codelock/axema/usersync	Query Axema user sync jobs	Returns a list of sync jobs for the company, optionally filtered by status.

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
Imports BokaMera.API.ServiceModel.Enums

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 QueryAxemaUserSyncJobs
            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

            '''<Summary>
            '''Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
            '''</Summary>
            <ApiMember(Description:="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")>
            Public Overridable Property Status As AxemaUserSyncStatus?
        End Class

        Public Partial Class QueryAxemaUserSyncJobsResponse
            Public Overridable Property Results As List(Of AxemaUserSyncJobResponse) = New List(Of AxemaUserSyncJobResponse)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum AxemaUserSyncStatus
            Pending
            Processing
            Completed
            Failed
        End Enum
    End Namespace
End Namespace

VB.NET QueryAxemaUserSyncJobs DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /codelock/axema/usersync HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"Status":0,"StatusName":"String","UsersFound":0,"UsersCreated":0,"UsersUpdated":0,"ErrorMessage":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}