BokaMera.API.Host

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/usersync	Query Axema user sync jobs	Returns a list of sync jobs for the company, optionally filtered by status.

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;
}

class QueryAxemaUserSyncJobsResponse implements IConvertible
{
    List<AxemaUserSyncJobResponse> Results = [];
    ResponseStatus ResponseStatus;

    QueryAxemaUserSyncJobsResponse({this.Results,this.ResponseStatus});
    QueryAxemaUserSyncJobsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Results = JsonConverters.fromJson(json['Results'],'List<AxemaUserSyncJobResponse>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Results': JsonConverters.toJson(Results,'List<AxemaUserSyncJobResponse>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

enum AxemaUserSyncStatus
{
    Pending,
    Processing,
    Completed,
    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)
class QueryAxemaUserSyncJobs implements ICompany, IConvertible
{
    /**
    * 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;

    /**
    * Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
    */
    // @ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")
    AxemaUserSyncStatus? Status;

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

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Status = JsonConverters.fromJson(json['Status'],'AxemaUserSyncStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Status': JsonConverters.toJson(Status,'AxemaUserSyncStatus',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'AxemaUserSyncJobResponse': TypeInfo(TypeOf.Class, create:() => AxemaUserSyncJobResponse()),
    'QueryAxemaUserSyncJobsResponse': TypeInfo(TypeOf.Class, create:() => QueryAxemaUserSyncJobsResponse()),
    'List<AxemaUserSyncJobResponse>': TypeInfo(TypeOf.Class, create:() => <AxemaUserSyncJobResponse>[]),
    'AxemaUserSyncStatus': TypeInfo(TypeOf.Enum, enumValues:AxemaUserSyncStatus.values),
    'QueryAxemaUserSyncJobs': TypeInfo(TypeOf.Class, create:() => QueryAxemaUserSyncJobs()),
});

Dart QueryAxemaUserSyncJobs DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryAxemaUserSyncJobsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results>
    <AxemaUserSyncJobResponse>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <ErrorMessage>String</ErrorMessage>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Status>0</Status>
      <StatusName>String</StatusName>
      <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
      <UsersCreated>0</UsersCreated>
      <UsersFound>0</UsersFound>
      <UsersUpdated>0</UsersUpdated>
    </AxemaUserSyncJobResponse>
  </Results>
</QueryAxemaUserSyncJobsResponse>