| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /codelock/axema/usersync | Query Axema user sync jobs | Returns a list of sync jobs for the company, optionally filtered by status. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class AxemaUserSyncJobResponse implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $CompanyId='',
/** @var int */
public int $Status=0,
/** @var string */
public string $StatusName='',
/** @var int|null */
public ?int $UsersFound=null,
/** @var int|null */
public ?int $UsersCreated=null,
/** @var int|null */
public ?int $UsersUpdated=null,
/** @var string|null */
public ?string $ErrorMessage=null,
/** @var DateTime */
public DateTime $CreatedDate=new DateTime(),
/** @var DateTime */
public DateTime $UpdatedDate=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['StatusName'])) $this->StatusName = $o['StatusName'];
if (isset($o['UsersFound'])) $this->UsersFound = $o['UsersFound'];
if (isset($o['UsersCreated'])) $this->UsersCreated = $o['UsersCreated'];
if (isset($o['UsersUpdated'])) $this->UsersUpdated = $o['UsersUpdated'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
if (isset($o['UpdatedDate'])) $this->UpdatedDate = JsonConverters::from('DateTime', $o['UpdatedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->StatusName)) $o['StatusName'] = $this->StatusName;
if (isset($this->UsersFound)) $o['UsersFound'] = $this->UsersFound;
if (isset($this->UsersCreated)) $o['UsersCreated'] = $this->UsersCreated;
if (isset($this->UsersUpdated)) $o['UsersUpdated'] = $this->UsersUpdated;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
if (isset($this->UpdatedDate)) $o['UpdatedDate'] = JsonConverters::to('DateTime', $this->UpdatedDate);
return empty($o) ? new class(){} : $o;
}
}
class QueryAxemaUserSyncJobsResponse implements JsonSerializable
{
public function __construct(
/** @var array<AxemaUserSyncJobResponse>|null */
public ?array $Results=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('AxemaUserSyncJobResponse', $o['Results']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('AxemaUserSyncJobResponse', $this->Results);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
enum AxemaUserSyncStatus : string
{
case Pending = 'Pending';
case Processing = 'Processing';
case Completed = 'Completed';
case Failed = '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, JsonSerializable
{
public function __construct(
/** @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.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed). */
// @ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")
/** @var AxemaUserSyncStatus|null */
public ?AxemaUserSyncStatus $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Status'])) $this->Status = JsonConverters::from('AxemaUserSyncStatus', $o['Status']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Status)) $o['Status'] = JsonConverters::to('AxemaUserSyncStatus', $this->Status);
return empty($o) ? new class(){} : $o;
}
}
PHP QueryAxemaUserSyncJobs DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>