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.

import Foundation
import ServiceStack

// @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 class QueryAxemaUserSyncJobs : ICompany, Codable
{
    /**
    * 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.")
    public var companyId:String?

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

    required public init(){}
}

public enum AxemaUserSyncStatus : String, Codable
{
    case Pending
    case Processing
    case Completed
    case Failed
}

public class QueryAxemaUserSyncJobsResponse : Codable
{
    public var results:[AxemaUserSyncJobResponse] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class AxemaUserSyncJobResponse : Codable
{
    public var id:String
    public var companyId:String
    public var status:Int
    public var statusName:String
    public var usersFound:Int?
    public var usersCreated:Int?
    public var usersUpdated:Int?
    public var errorMessage:String
    public var createdDate:Date
    public var updatedDate:Date

    required public init(){}
}

Swift 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
		}
	}
}