Platform API

<back to all web services

IsConnectedInRole

Return true/false if a contact is connected to a licensee in a specific role.

<?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};


// @ApiResponse(Description="Returns whether or not a contact with a specific role is connected to a licensee.")
class IsConnectedInRoleResponse implements JsonSerializable
{
    public function __construct(
        /** @description True or false depending on if the contact is connected to the licensee in the role. */
        // @ApiMember(DataType="bool", Description="True or false depending on if the contact is connected to the licensee in the role.", Name="IsConnected")
        /** @var bool|null */
        public ?bool $IsConnected=null,

        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

/** @description Return true/false if a contact is connected to a licensee in a specific role. */
// @Api(Description="Return true/false if a contact is connected to a licensee in a specific role.")
class IsConnectedInRole implements JsonSerializable
{
    public function __construct(
        /** @description Contact Id of the contact to determine if they have the role with the licensee. */
        // @ApiMember(DataType="Guid", Description="Contact Id of the contact to determine if they have the role with the licensee.", IsRequired=true, Name="ContactId")
        /** @var string */
        public string $ContactId='',

        /** @description Role to check for. */
        // @ApiMember(DataType="Guid", Description="Role to check for.", IsRequired=true, Name="RoleId")
        /** @var string */
        public string $RoleId='',

        /** @description Licensee Contact Id we are checking if we're connected to. */
        // @ApiMember(DataType="Guid", Description="Licensee Contact Id we are checking if we're connected to.", IsRequired=true, Name="LicenseeId")
        /** @var string */
        public string $LicenseeId=''
    ) {
    }

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

PHP IsConnectedInRole DTOs

POST /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<IsConnectedInRoleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <IsConnected>false</IsConnected>
  <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>
</IsConnectedInRoleResponse>