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.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@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)
open class QueryAxemaUserSyncJobs : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    override var CompanyId:UUID? = null

    /**
    * Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
    */
    @ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")
    open var Status:AxemaUserSyncStatus? = null
}

enum class AxemaUserSyncStatus
{
    Pending,
    Processing,
    Completed,
    Failed,
}

open class QueryAxemaUserSyncJobsResponse
{
    open var Results:ArrayList<AxemaUserSyncJobResponse> = ArrayList<AxemaUserSyncJobResponse>()
    open var ResponseStatus:ResponseStatus? = null
}

open class AxemaUserSyncJobResponse
{
    open var Id:UUID? = null
    open var CompanyId:UUID? = null
    open var Status:Int? = null
    open var StatusName:String? = null
    open var UsersFound:Int? = null
    open var UsersCreated:Int? = null
    open var UsersUpdated:Int? = null
    open var ErrorMessage:String? = null
    open var CreatedDate:Date? = null
    open var UpdatedDate:Date? = null
}

Kotlin QueryAxemaUserSyncJobs 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 HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}