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.
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @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)
    public static class QueryAxemaUserSyncJobs implements ICompany
    {
        /**
        * 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 UUID CompanyId = null;

        /**
        * 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 AxemaUserSyncStatus Status = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public QueryAxemaUserSyncJobs setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public AxemaUserSyncStatus getStatus() { return Status; }
        public QueryAxemaUserSyncJobs setStatus(AxemaUserSyncStatus value) { this.Status = value; return this; }
    }

    public static enum AxemaUserSyncStatus
    {
        Pending,
        Processing,
        Completed,
        Failed;
    }

    public static class QueryAxemaUserSyncJobsResponse
    {
        public ArrayList<AxemaUserSyncJobResponse> Results = new ArrayList<AxemaUserSyncJobResponse>();
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<AxemaUserSyncJobResponse> getResults() { return Results; }
        public QueryAxemaUserSyncJobsResponse setResults(ArrayList<AxemaUserSyncJobResponse> value) { this.Results = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryAxemaUserSyncJobsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AxemaUserSyncJobResponse
    {
        public UUID Id = null;
        public UUID CompanyId = null;
        public Integer Status = null;
        public String StatusName = null;
        public Integer UsersFound = null;
        public Integer UsersCreated = null;
        public Integer UsersUpdated = null;
        public String ErrorMessage = null;
        public Date CreatedDate = null;
        public Date UpdatedDate = null;
        
        public UUID getId() { return Id; }
        public AxemaUserSyncJobResponse setId(UUID value) { this.Id = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public AxemaUserSyncJobResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getStatus() { return Status; }
        public AxemaUserSyncJobResponse setStatus(Integer value) { this.Status = value; return this; }
        public String getStatusName() { return StatusName; }
        public AxemaUserSyncJobResponse setStatusName(String value) { this.StatusName = value; return this; }
        public Integer getUsersFound() { return UsersFound; }
        public AxemaUserSyncJobResponse setUsersFound(Integer value) { this.UsersFound = value; return this; }
        public Integer getUsersCreated() { return UsersCreated; }
        public AxemaUserSyncJobResponse setUsersCreated(Integer value) { this.UsersCreated = value; return this; }
        public Integer getUsersUpdated() { return UsersUpdated; }
        public AxemaUserSyncJobResponse setUsersUpdated(Integer value) { this.UsersUpdated = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public AxemaUserSyncJobResponse setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public AxemaUserSyncJobResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getUpdatedDate() { return UpdatedDate; }
        public AxemaUserSyncJobResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
    }

}

Java QueryAxemaUserSyncJobs 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 HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}