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 Foundation
import ServiceStack

// @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 class GetAxemaUserSyncJob : ICompany, Codable
{
    /**
    * The sync job id.
    */
    // @ApiMember(Description="The sync job id.", IsRequired=true)
    public var id:String

    /**
    * 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 var companyId:String?

    required public init(){}
}

public class AxemaUserSyncJobResponse : Codable
{
    public var id:String
    public var companyId:String
    public var status:Int
    public var statusName:String
    public var usersFound:Int?
    public var usersCreated:Int?
    public var usersUpdated:Int?
    public var errorMessage:String
    public var createdDate:Date
    public var updatedDate:Date

    required public init(){}
}


Swift GetAxemaUserSyncJob 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/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AxemaUserSyncJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <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>