BokaMera.API.Host

<back to all web services

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/usersyncQuery Axema user sync jobsReturns a list of sync jobs for the company, optionally filtered by status.
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 AxemaUserSyncJobResponse() = 
        member val Id:Guid = new Guid() with get,set
        member val CompanyId:Guid = new Guid() with get,set
        member val Status:Int32 = new Int32() with get,set
        member val StatusName:String = null with get,set
        member val UsersFound:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UsersCreated:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UsersUpdated:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ErrorMessage:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val UpdatedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type QueryAxemaUserSyncJobsResponse() = 
        member val Results:ResizeArray<AxemaUserSyncJobResponse> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    type AxemaUserSyncStatus =
        | Pending = 0
        | Processing = 1
        | Completed = 2
        | Failed = 3

    [<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)>]
    [<AllowNullLiteral>]
    type QueryAxemaUserSyncJobs() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<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).")>]
        member val Status:Nullable<AxemaUserSyncStatus> = new Nullable<AxemaUserSyncStatus>() with get,set

F# QueryAxemaUserSyncJobs 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.

GET /codelock/axema/usersync HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}