| 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. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AxemaUserSyncJobResponse:
id: Optional[str] = None
company_id: Optional[str] = None
status: int = 0
status_name: Optional[str] = None
users_found: Optional[int] = None
users_created: Optional[int] = None
users_updated: Optional[int] = None
error_message: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryAxemaUserSyncJobsResponse:
results: List[AxemaUserSyncJobResponse] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
class AxemaUserSyncStatus(str, Enum):
PENDING = 'Pending'
PROCESSING = 'Processing'
COMPLETED = 'Completed'
FAILED = 'Failed'
# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryAxemaUserSyncJobs(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")
status: Optional[AxemaUserSyncStatus] = None
"""
Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
"""
Python QueryAxemaUserSyncJobs DTOs
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: 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
}
}
}