| POST | /api/roles |
|---|
<?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 ListItemFilterModel implements JsonSerializable
{
public function __construct(
/** @var string */
public string $ListItemFilterId='',
/** @var string|null */
public ?string $FilterName=null,
/** @var string */
public string $ListId='',
/** @var string */
public string $ListItemId='',
/** @var bool|null */
public ?bool $ListItemIsInFilter=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ListItemFilterId'])) $this->ListItemFilterId = $o['ListItemFilterId'];
if (isset($o['FilterName'])) $this->FilterName = $o['FilterName'];
if (isset($o['ListId'])) $this->ListId = $o['ListId'];
if (isset($o['ListItemId'])) $this->ListItemId = $o['ListItemId'];
if (isset($o['ListItemIsInFilter'])) $this->ListItemIsInFilter = $o['ListItemIsInFilter'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ListItemFilterId)) $o['ListItemFilterId'] = $this->ListItemFilterId;
if (isset($this->FilterName)) $o['FilterName'] = $this->FilterName;
if (isset($this->ListId)) $o['ListId'] = $this->ListId;
if (isset($this->ListItemId)) $o['ListItemId'] = $this->ListItemId;
if (isset($this->ListItemIsInFilter)) $o['ListItemIsInFilter'] = $this->ListItemIsInFilter;
return empty($o) ? new class(){} : $o;
}
}
class RoleDetailsModel implements JsonSerializable
{
public function __construct(
/** @description Role Id */
// @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
/** @var string */
public string $RoleId='',
/** @description Role Name */
// @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
/** @var string|null */
public ?string $RoleName=null,
/** @description Role Connection Definition Id */
// @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
/** @var string */
public string $RoleConnectionDefinitionId='',
/** @description Contact Types the Role applies to */
// @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
/** @var array<string>|null */
public ?array $ContactTypes=null,
/** @description Does the role require contacts to accept it? */
// @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
/** @var bool|null */
public ?bool $RequireContactsToAccept=null,
/** @description Filters linked to the custom role. */
// @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
/** @var array<ListItemFilterModel>|null */
public ?array $ListItemFilters=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RoleId'])) $this->RoleId = $o['RoleId'];
if (isset($o['RoleName'])) $this->RoleName = $o['RoleName'];
if (isset($o['RoleConnectionDefinitionId'])) $this->RoleConnectionDefinitionId = $o['RoleConnectionDefinitionId'];
if (isset($o['ContactTypes'])) $this->ContactTypes = JsonConverters::fromArray('Guid', $o['ContactTypes']);
if (isset($o['RequireContactsToAccept'])) $this->RequireContactsToAccept = $o['RequireContactsToAccept'];
if (isset($o['ListItemFilters'])) $this->ListItemFilters = JsonConverters::fromArray('ListItemFilterModel', $o['ListItemFilters']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RoleId)) $o['RoleId'] = $this->RoleId;
if (isset($this->RoleName)) $o['RoleName'] = $this->RoleName;
if (isset($this->RoleConnectionDefinitionId)) $o['RoleConnectionDefinitionId'] = $this->RoleConnectionDefinitionId;
if (isset($this->ContactTypes)) $o['ContactTypes'] = JsonConverters::toArray('Guid', $this->ContactTypes);
if (isset($this->RequireContactsToAccept)) $o['RequireContactsToAccept'] = $this->RequireContactsToAccept;
if (isset($this->ListItemFilters)) $o['ListItemFilters'] = JsonConverters::toArray('ListItemFilterModel', $this->ListItemFilters);
return empty($o) ? new class(){} : $o;
}
}
/** @description Add a custom role for the licensee */
// @Api(Description="Add a custom role for the licensee")
class AddContactRole implements JsonSerializable
{
public function __construct(
/** @description Details of the Contact Role to be Added. */
// @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Added.", IsRequired=true, Name="RoleDetails", ParameterType="query")
/** @var RoleDetailsModel|null */
public ?RoleDetailsModel $RoleDetails=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RoleDetails'])) $this->RoleDetails = JsonConverters::from('RoleDetailsModel', $o['RoleDetails']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RoleDetails)) $o['RoleDetails'] = JsonConverters::to('RoleDetailsModel', $this->RoleDetails);
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 /api/roles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddContactRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<RoleDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
</d2p1:ContactTypes>
<d2p1:ListItemFilters>
<d2p1:ListItemFilterModel>
<d2p1:FilterName>String</d2p1:FilterName>
<d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
<d2p1:ListItemFilterId>00000000-0000-0000-0000-000000000000</d2p1:ListItemFilterId>
<d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
<d2p1:ListItemIsInFilter>false</d2p1:ListItemIsInFilter>
</d2p1:ListItemFilterModel>
</d2p1:ListItemFilters>
<d2p1:RequireContactsToAccept>false</d2p1:RequireContactsToAccept>
<d2p1:RoleConnectionDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:RoleConnectionDefinitionId>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
</RoleDetails>
</AddContactRole>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>