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.
// @ts-nocheck

export class AxemaUserSyncJobResponse
{
    public Id: string;
    public CompanyId: string;
    public Status: number;
    public StatusName: string;
    public UsersFound?: number;
    public UsersCreated?: number;
    public UsersUpdated?: number;
    public ErrorMessage?: string;
    public CreatedDate: string;
    public UpdatedDate: string;

    public constructor(init?: Partial<AxemaUserSyncJobResponse>) { (Object as any).assign(this, init); }
}

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

    /** @description 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 CompanyId?: string;

    public constructor(init?: Partial<GetAxemaUserSyncJob>) { (Object as any).assign(this, init); }
}

TypeScript 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>