| PUT | /Key | ||
|---|---|---|---|
| PUT | /Key/{Id} | ||
| GET POST | /UpdateKey | ||
| GET POST | /UpdateKey/{Id} |
<?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};
// @DataContract
class UpdateKeyResponse implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class UpdateKey implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $id=null,
// @DataMember
/** @var string|null */
public ?string $name=null,
// @DataMember
/** @var string|null */
public ?string $serialNumber=null,
// @DataMember
/** @var string|null */
public ?string $keyValid=null,
// @DataMember
/** @var string|null */
public ?string $keyExpire=null,
// @DataMember
/** @var bool|null */
public ?bool $isAdmin=null,
// @DataMember
/** @var string|null */
public ?string $companyName=null,
// @DataMember
/** @var string|null */
public ?string $email=null,
// @DataMember
/** @var string|null */
public ?string $mobile=null,
// @DataMember
/** @var string|null */
public ?string $phone=null,
// @DataMember
/** @var string|null */
public ?string $note=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $expirationDate=null,
// @DataMember
/** @var string|null */
public ?string $employeeNumber=null,
// @DataMember
/** @var bool|null */
public ?bool $clear=null,
// @DataMember
/** @var string[]|null */
public ?array $addUnits=null,
// @DataMember
/** @var string[]|null */
public ?array $removeUnits=null,
// @DataMember
/** @var string[]|null */
public ?array $addGroups=null,
// @DataMember
/** @var string[]|null */
public ?array $removeGroups=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['serialNumber'])) $this->serialNumber = $o['serialNumber'];
if (isset($o['keyValid'])) $this->keyValid = $o['keyValid'];
if (isset($o['keyExpire'])) $this->keyExpire = $o['keyExpire'];
if (isset($o['isAdmin'])) $this->isAdmin = $o['isAdmin'];
if (isset($o['companyName'])) $this->companyName = $o['companyName'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['mobile'])) $this->mobile = $o['mobile'];
if (isset($o['phone'])) $this->phone = $o['phone'];
if (isset($o['note'])) $this->note = $o['note'];
if (isset($o['expirationDate'])) $this->expirationDate = JsonConverters::from('DateTime', $o['expirationDate']);
if (isset($o['employeeNumber'])) $this->employeeNumber = $o['employeeNumber'];
if (isset($o['clear'])) $this->clear = $o['clear'];
if (isset($o['addUnits'])) $this->addUnits = JsonConverters::fromArray('string', $o['addUnits']);
if (isset($o['removeUnits'])) $this->removeUnits = JsonConverters::fromArray('string', $o['removeUnits']);
if (isset($o['addGroups'])) $this->addGroups = JsonConverters::fromArray('string', $o['addGroups']);
if (isset($o['removeGroups'])) $this->removeGroups = JsonConverters::fromArray('string', $o['removeGroups']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->serialNumber)) $o['serialNumber'] = $this->serialNumber;
if (isset($this->keyValid)) $o['keyValid'] = $this->keyValid;
if (isset($this->keyExpire)) $o['keyExpire'] = $this->keyExpire;
if (isset($this->isAdmin)) $o['isAdmin'] = $this->isAdmin;
if (isset($this->companyName)) $o['companyName'] = $this->companyName;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->mobile)) $o['mobile'] = $this->mobile;
if (isset($this->phone)) $o['phone'] = $this->phone;
if (isset($this->note)) $o['note'] = $this->note;
if (isset($this->expirationDate)) $o['expirationDate'] = JsonConverters::to('DateTime', $this->expirationDate);
if (isset($this->employeeNumber)) $o['employeeNumber'] = $this->employeeNumber;
if (isset($this->clear)) $o['clear'] = $this->clear;
if (isset($this->addUnits)) $o['addUnits'] = JsonConverters::toArray('string', $this->addUnits);
if (isset($this->removeUnits)) $o['removeUnits'] = JsonConverters::toArray('string', $this->removeUnits);
if (isset($this->addGroups)) $o['addGroups'] = JsonConverters::toArray('string', $this->addGroups);
if (isset($this->removeGroups)) $o['removeGroups'] = JsonConverters::toArray('string', $this->removeGroups);
return empty($o) ? new class(){} : $o;
}
}
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.
POST /UpdateKey HTTP/1.1
Host: api.trackunit.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<AddGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddGroups>
<AddUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddUnits>
<Clear>false</Clear>
<CompanyName>String</CompanyName>
<Email>String</Email>
<EmployeeNumber>String</EmployeeNumber>
<ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
<Id>String</Id>
<IsAdmin>false</IsAdmin>
<KeyExpire>String</KeyExpire>
<KeyValid>String</KeyValid>
<Mobile>String</Mobile>
<Name>String</Name>
<Note>String</Note>
<Phone>String</Phone>
<RemoveGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveGroups>
<RemoveUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveUnits>
<SerialNumber>String</SerialNumber>
</UpdateKey>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<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>
</Meta>
</ResponseError>
</Errors>
<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>
</Meta>
</ResponseStatus>
</UpdateKeyResponse>