BokaMera.API.Host

<back to all web services

GetAxemaUserSyncJob

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/{Id}Get a single Axema user sync job by idReturns the sync job details including progress counters.
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

    [<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 GetAxemaUserSyncJob() = 
        ///<summary>
        ///The sync job id.
        ///</summary>
        [<ApiMember(Description="The sync job id.", IsRequired=true)>]
        member val Id:Guid = new Guid() with get,set

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

F# GetAxemaUserSyncJob DTOs

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

HTTP + JSV

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

GET /codelock/axema/usersync/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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