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.
// @ts-nocheck

export class AxemaUserSyncJobResponse
{
    public Id: string;
    public CompanyId: string;
    public Status: number;
    public StatusName: string;
    public UsersFound?: number;
    public UsersCreated?: number;
    public UsersUpdated?: number;
    public ErrorMessage?: string;
    public CreatedDate: string;
    public UpdatedDate: string;

    public constructor(init?: Partial<AxemaUserSyncJobResponse>) { (Object as any).assign(this, init); }
}

export class QueryAxemaUserSyncJobsResponse
{
    public Results: AxemaUserSyncJobResponse[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryAxemaUserSyncJobsResponse>) { (Object as any).assign(this, init); }
}

export enum AxemaUserSyncStatus
{
    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)
export class QueryAxemaUserSyncJobs implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description 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 Status?: AxemaUserSyncStatus;

    public constructor(init?: Partial<QueryAxemaUserSyncJobs>) { (Object as any).assign(this, init); }
}

TypeScript QueryAxemaUserSyncJobs DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}