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.
QueryAxemaUserSyncJobs Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
StatusqueryAxemaUserSyncStatus?NoFilter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
AxemaUserSyncStatus Enum:
Pending
Processing
Completed
Failed
QueryAxemaUserSyncJobsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<AxemaUserSyncJobResponse>Yes
ResponseStatusformResponseStatusYes
AxemaUserSyncJobResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CompanyIdformGuidNo
StatusformintNo
StatusNameformstringYes
UsersFoundformint?No
UsersCreatedformint?No
UsersUpdatedformint?No
ErrorMessageformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo

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: testapi.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
		}
	}
}