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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AxemaUserSyncJobResponse
    {
        public virtual Guid Id { get; set; }
        public virtual Guid CompanyId { get; set; }
        public virtual int Status { get; set; }
        public virtual string StatusName { get; set; }
        public virtual int? UsersFound { get; set; }
        public virtual int? UsersCreated { get; set; }
        public virtual int? UsersUpdated { get; set; }
        public virtual string? ErrorMessage { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime UpdatedDate { get; set; }
    }

    [ValidateRequest("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 partial class QueryAxemaUserSyncJobs
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
        ///</summary>
        [ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")]
        public virtual AxemaUserSyncStatus? Status { get; set; }
    }

    public partial class QueryAxemaUserSyncJobsResponse
    {
        public virtual List<AxemaUserSyncJobResponse> Results { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum AxemaUserSyncStatus
    {
        Pending,
        Processing,
        Completed,
        Failed,
    }

}

C# QueryAxemaUserSyncJobs DTOs

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

HTTP + 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
		}
	}
}