| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /codelock/axema/usersync | Query Axema user sync jobs | Returns a list of sync jobs for the company, optionally filtered by status. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Status | query | AxemaUserSyncStatus? | No | Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed). |
| Pending | |
| Processing | |
| Completed | |
| Failed |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<AxemaUserSyncJobResponse> | Yes | |
| ResponseStatus | form | ResponseStatus | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| CompanyId | form | Guid | No | |
| Status | form | int | No | |
| StatusName | form | string | Yes | |
| UsersFound | form | int? | No | |
| UsersCreated | form | int? | No | |
| UsersUpdated | form | int? | No | |
| ErrorMessage | form | string | No | |
| CreatedDate | form | DateTime | No | |
| UpdatedDate | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}