BokaMera.API.Host

<back to all web services

GetAxemaUserSyncJob

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/{Id}Get a single Axema user sync job by idReturns the sync job details including progress counters.
import 'package:servicestack/servicestack.dart';

class AxemaUserSyncJobResponse implements IConvertible
{
    String Id = "";
    String CompanyId = "";
    int Status = 0;
    String StatusName = "";
    int? UsersFound;
    int? UsersCreated;
    int? UsersUpdated;
    String? ErrorMessage;
    DateTime CreatedDate = DateTime(0);
    DateTime UpdatedDate = DateTime(0);

    AxemaUserSyncJobResponse({this.Id,this.CompanyId,this.Status,this.StatusName,this.UsersFound,this.UsersCreated,this.UsersUpdated,this.ErrorMessage,this.CreatedDate,this.UpdatedDate});
    AxemaUserSyncJobResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CompanyId = json['CompanyId'];
        Status = json['Status'];
        StatusName = json['StatusName'];
        UsersFound = json['UsersFound'];
        UsersCreated = json['UsersCreated'];
        UsersUpdated = json['UsersUpdated'];
        ErrorMessage = json['ErrorMessage'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        UpdatedDate = JsonConverters.fromJson(json['UpdatedDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CompanyId': CompanyId,
        'Status': Status,
        'StatusName': StatusName,
        'UsersFound': UsersFound,
        'UsersCreated': UsersCreated,
        'UsersUpdated': UsersUpdated,
        'ErrorMessage': ErrorMessage,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'UpdatedDate': JsonConverters.toJson(UpdatedDate,'DateTime',context!)
    };

    getTypeName() => "AxemaUserSyncJobResponse";
    TypeContext? context = _ctx;
}

// @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)
class GetAxemaUserSyncJob implements ICompany, IConvertible
{
    /**
    * The sync job id.
    */
    // @ApiMember(Description="The sync job id.", IsRequired=true)
    String Id = "";

    /**
    * 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.")
    String? CompanyId;

    GetAxemaUserSyncJob({this.Id,this.CompanyId});
    GetAxemaUserSyncJob.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CompanyId = json['CompanyId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CompanyId': CompanyId
    };

    getTypeName() => "GetAxemaUserSyncJob";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'AxemaUserSyncJobResponse': TypeInfo(TypeOf.Class, create:() => AxemaUserSyncJobResponse()),
    'GetAxemaUserSyncJob': TypeInfo(TypeOf.Class, create:() => GetAxemaUserSyncJob()),
});

Dart GetAxemaUserSyncJob DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /codelock/axema/usersync/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":0,"StatusName":"String","UsersFound":0,"UsersCreated":0,"UsersUpdated":0,"ErrorMessage":"String"}