| All Verbs | /api/contactrolegroups/{LicenseeId} |
|---|
<?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};
enum SortOrder : string
{
case Ascending = 'Ascending';
case Descending = 'Descending';
}
class PagedModel implements JsonSerializable
{
public function __construct(
/** @description Page Number to retrieve */
// @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
/** @var int */
public int $PageNumber=0,
/** @description Number of records to retrieve */
// @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
/** @var int */
public int $PageSize=0,
/** @description Index of field to sort results by */
// @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
/** @var int */
public int $SortIndex=0,
/** @description Sort Order - Ascending or Descending */
// @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
/** @var SortOrder|null */
public ?SortOrder $SortOrder=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PageNumber'])) $this->PageNumber = $o['PageNumber'];
if (isset($o['PageSize'])) $this->PageSize = $o['PageSize'];
if (isset($o['SortIndex'])) $this->SortIndex = $o['SortIndex'];
if (isset($o['SortOrder'])) $this->SortOrder = JsonConverters::from('SortOrder', $o['SortOrder']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PageNumber)) $o['PageNumber'] = $this->PageNumber;
if (isset($this->PageSize)) $o['PageSize'] = $this->PageSize;
if (isset($this->SortIndex)) $o['SortIndex'] = $this->SortIndex;
if (isset($this->SortOrder)) $o['SortOrder'] = JsonConverters::to('SortOrder', $this->SortOrder);
return empty($o) ? new class(){} : $o;
}
}
class RoleGroupRolesModel 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 Group Id */
// @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
/** @var string */
public string $RoleGroupId='',
/** @description Role Group Name */
// @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
/** @var string|null */
public ?string $RoleGroupName=null,
/** @description Role Group Role Id */
// @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
/** @var string */
public string $RoleGroupRoleId='',
/** @description 'A' (Active), 'I' (Inactive) */
// @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
/** @var string|null */
public ?string $RecordStatus=null,
/** @description Owner Contact Id */
// @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
/** @var string */
public string $OwnerContactId=''
) {
}
/** @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['RoleGroupId'])) $this->RoleGroupId = $o['RoleGroupId'];
if (isset($o['RoleGroupName'])) $this->RoleGroupName = $o['RoleGroupName'];
if (isset($o['RoleGroupRoleId'])) $this->RoleGroupRoleId = $o['RoleGroupRoleId'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
if (isset($o['OwnerContactId'])) $this->OwnerContactId = $o['OwnerContactId'];
}
/** @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->RoleGroupId)) $o['RoleGroupId'] = $this->RoleGroupId;
if (isset($this->RoleGroupName)) $o['RoleGroupName'] = $this->RoleGroupName;
if (isset($this->RoleGroupRoleId)) $o['RoleGroupRoleId'] = $this->RoleGroupRoleId;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
if (isset($this->OwnerContactId)) $o['OwnerContactId'] = $this->OwnerContactId;
return empty($o) ? new class(){} : $o;
}
}
class RoleGroupModel implements JsonSerializable
{
public function __construct(
/** @description Role Group Id */
// @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
/** @var string */
public string $RoleGroupId='',
/** @description Role Group Name */
// @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
/** @var string|null */
public ?string $Name=null,
/** @description Owner Contact Id */
// @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
/** @var string */
public string $OwnerContactId='',
/** @description Number of Roles */
// @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
/** @var int */
public int $NumberOfRoles=0,
/** @description Roles belonging to the Role Group */
// @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
/** @var array<RoleGroupRolesModel>|null */
public ?array $Roles=null,
/** @description 'A' (Active), 'I' (Inactive) */
// @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
/** @var string|null */
public ?string $RecordStatus=null,
/** @description True if Licensee-owned, allowing editing, deleting, archiving */
// @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
/** @var bool|null */
public ?bool $AllowEdit=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RoleGroupId'])) $this->RoleGroupId = $o['RoleGroupId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['OwnerContactId'])) $this->OwnerContactId = $o['OwnerContactId'];
if (isset($o['NumberOfRoles'])) $this->NumberOfRoles = $o['NumberOfRoles'];
if (isset($o['Roles'])) $this->Roles = JsonConverters::fromArray('RoleGroupRolesModel', $o['Roles']);
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
if (isset($o['AllowEdit'])) $this->AllowEdit = $o['AllowEdit'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RoleGroupId)) $o['RoleGroupId'] = $this->RoleGroupId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->OwnerContactId)) $o['OwnerContactId'] = $this->OwnerContactId;
if (isset($this->NumberOfRoles)) $o['NumberOfRoles'] = $this->NumberOfRoles;
if (isset($this->Roles)) $o['Roles'] = JsonConverters::toArray('RoleGroupRolesModel', $this->Roles);
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
if (isset($this->AllowEdit)) $o['AllowEdit'] = $this->AllowEdit;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="List of role groups")
class GetContactRoleGroupsResponse implements JsonSerializable
{
public function __construct(
/** @var array<RoleGroupModel>|null */
public ?array $RoleGroups=null,
/** @var int */
public int $TotalRoleGroups=0,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RoleGroups'])) $this->RoleGroups = JsonConverters::fromArray('RoleGroupModel', $o['RoleGroups']);
if (isset($o['TotalRoleGroups'])) $this->TotalRoleGroups = $o['TotalRoleGroups'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RoleGroups)) $o['RoleGroups'] = JsonConverters::toArray('RoleGroupModel', $this->RoleGroups);
if (isset($this->TotalRoleGroups)) $o['TotalRoleGroups'] = $this->TotalRoleGroups;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get role groups for the given criteria */
// @Api(Description="Get role groups for the given criteria")
class GetContactRoleGroups extends PagedModel implements JsonSerializable
{
/**
* @param int $PageNumber
* @param int $PageSize
* @param int $SortIndex
* @param SortOrder|null $SortOrder
*/
public function __construct(
int $PageNumber=0,
int $PageSize=0,
int $SortIndex=0,
?SortOrder $SortOrder=null,
/** @description Get contact role groups for the specified licensee */
// @ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
/** @var string */
public string $LicenseeId='',
/** @description Role Group Name */
// @ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
/** @var string|null */
public ?string $Name=null,
/** @description Active/Archived filter */
// @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
/** @var string|null */
public ?string $RecordStatus=null
) {
parent::__construct($PageNumber,$PageSize,$SortIndex,$SortOrder);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['LicenseeId'])) $this->LicenseeId = $o['LicenseeId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->LicenseeId)) $o['LicenseeId'] = $this->LicenseeId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactrolegroups/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","Name":"String","RecordStatus":"String","PageNumber":0,"PageSize":0,"SortIndex":0,"SortOrder":"Ascending"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"RoleGroups":[{"RoleGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","NumberOfRoles":0,"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleGroupId":"00000000-0000-0000-0000-000000000000","RoleGroupName":"String","RoleGroupRoleId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000"}],"RecordStatus":"String","AllowEdit":false}],"TotalRoleGroups":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}