| GET | /api/safetycommitment | ||
|---|---|---|---|
| GET | /api/terms |
<?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 GetTermsDetailsResponse implements JsonSerializable
{
public function __construct(
/** @description Should Commitment to Safety be displayed? */
// @ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")
/** @var bool|null */
public ?bool $DisplaySafetyCommitment=null,
/** @description Commitment to Safety HTML content. */
// @ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")
/** @var string|null */
public ?string $SafetyCommitmentContent=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DisplaySafetyCommitment'])) $this->DisplaySafetyCommitment = $o['DisplaySafetyCommitment'];
if (isset($o['SafetyCommitmentContent'])) $this->SafetyCommitmentContent = $o['SafetyCommitmentContent'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DisplaySafetyCommitment)) $o['DisplaySafetyCommitment'] = $this->DisplaySafetyCommitment;
if (isset($this->SafetyCommitmentContent)) $o['SafetyCommitmentContent'] = $this->SafetyCommitmentContent;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Retrieve details of the specified terms for the specified licensee and contact. */
// @Api(Description="Retrieve details of the specified terms for the specified licensee and contact.")
class GetTermsDetails implements JsonSerializable
{
public function __construct(
/** @description Accept terms for the specified licensee contact id. */
// @ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
/** @var string */
public string $LicenseeContactId='',
/** @description Terms are being accepted by the specified contact id. */
// @ApiMember(DataType="Guid", Description="Terms are being accepted by the specified contact id.", IsRequired=true, Name="ContactId")
/** @var string */
public string $ContactId='',
/** @description Contact Type e.g Real Person or Real Organisation. Defaults to real person. */
// @ApiMember(DataType="Guid", Description="Contact Type e.g Real Person or Real Organisation. Defaults to real person.", IsRequired=true, Name="ContactTypeId")
/** @var string */
public string $ContactTypeId='',
/** @description Accept terms for the specified appliance id. This is not required for Safety Commitment. */
// @ApiMember(DataType="Guid", Description="Accept terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")
/** @var string */
public string $ApplianceId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['LicenseeContactId'])) $this->LicenseeContactId = $o['LicenseeContactId'];
if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
if (isset($o['ContactTypeId'])) $this->ContactTypeId = $o['ContactTypeId'];
if (isset($o['ApplianceId'])) $this->ApplianceId = $o['ApplianceId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->LicenseeContactId)) $o['LicenseeContactId'] = $this->LicenseeContactId;
if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
if (isset($this->ContactTypeId)) $o['ContactTypeId'] = $this->ContactTypeId;
if (isset($this->ApplianceId)) $o['ApplianceId'] = $this->ApplianceId;
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.
GET /api/safetycommitment HTTP/1.1 Host: pfapi.pstpf.com.au Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetTermsDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<DisplaySafetyCommitment>false</DisplaySafetyCommitment>
<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>
<SafetyCommitmentContent>String</SafetyCommitmentContent>
</GetTermsDetailsResponse>