Platform API

<back to all web services

GetContactRoleGroupDetails

Get details of the specified contact role group

Requires Authentication
The following routes are available for this service:
All Verbs/api/contactrolegroup/{ContactRoleGroupId}
<?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 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="Details of the specified contact role group")
class GetContactRoleGroupDetailsResponse implements JsonSerializable
{
    public function __construct(
        /** @var RoleGroupModel|null */
        public ?RoleGroupModel $ContactRoleGroup=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ContactRoleGroup'])) $this->ContactRoleGroup = JsonConverters::from('RoleGroupModel', $o['ContactRoleGroup']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ContactRoleGroup)) $o['ContactRoleGroup'] = JsonConverters::to('RoleGroupModel', $this->ContactRoleGroup);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Get details of the specified contact role group */
// @Api(Description="Get details of the specified contact role group")
class GetContactRoleGroupDetails implements JsonSerializable
{
    public function __construct(
        /** @description The Contact Role Group Guid. Records retrieved will belong to this role group. */
        // @ApiMember(DataType="Guid", Description="The Contact Role Group Guid. Records retrieved will belong to this role group.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
        /** @var string */
        public string $ContactRoleGroupId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ContactRoleGroupId'])) $this->ContactRoleGroupId = $o['ContactRoleGroupId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ContactRoleGroupId)) $o['ContactRoleGroupId'] = $this->ContactRoleGroupId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetContactRoleGroupDetails DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contactrolegroup/{ContactRoleGroupId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContactRoleGroupDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleGroupId>00000000-0000-0000-0000-000000000000</ContactRoleGroupId>
</GetContactRoleGroupDetails>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetContactRoleGroupDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:AllowEdit>false</d2p1:AllowEdit>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:NumberOfRoles>0</d2p1:NumberOfRoles>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:RoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupId>
    <d2p1:Roles>
      <d2p1:RoleGroupRolesModel>
        <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
        <d2p1:RecordStatus>String</d2p1:RecordStatus>
        <d2p1:RoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupId>
        <d2p1:RoleGroupName>String</d2p1:RoleGroupName>
        <d2p1:RoleGroupRoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupRoleId>
        <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
        <d2p1:RoleName>String</d2p1:RoleName>
      </d2p1:RoleGroupRolesModel>
    </d2p1:Roles>
  </ContactRoleGroup>
  <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>
</GetContactRoleGroupDetailsResponse>