Platform API

<back to all web services

IsConnectedInRole

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

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns whether or not a contact with a specific role is connected to a licensee.")
class IsConnectedInRoleResponse implements IConvertible
{
    /**
    * 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")
    bool? IsConnected;

    ResponseStatus? ResponseStatus;

    IsConnectedInRoleResponse({this.IsConnected,this.ResponseStatus});
    IsConnectedInRoleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IsConnected = json['IsConnected'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IsConnected': IsConnected,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "IsConnectedInRoleResponse";
    TypeContext? context = _ctx;
}

/**
* 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 IConvertible
{
    /**
    * 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")
    String? ContactId;

    /**
    * Role to check for.
    */
    // @ApiMember(DataType="Guid", Description="Role to check for.", IsRequired=true, Name="RoleId")
    String? RoleId;

    /**
    * 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")
    String? LicenseeId;

    IsConnectedInRole({this.ContactId,this.RoleId,this.LicenseeId});
    IsConnectedInRole.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        RoleId = json['RoleId'];
        LicenseeId = json['LicenseeId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'RoleId': RoleId,
        'LicenseeId': LicenseeId
    };

    getTypeName() => "IsConnectedInRole";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'IsConnectedInRoleResponse': TypeInfo(TypeOf.Class, create:() => IsConnectedInRoleResponse()),
    'IsConnectedInRole': TypeInfo(TypeOf.Class, create:() => IsConnectedInRole()),
});

Dart 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>