Platform API

GetRolesForConnection

Get roles for the specified contact

The following routes are available for this service:
All Verbs	/api/roles/connection/{FromContactId}

**GetRolesForConnection** Parameters:
Name	Parameter	Data Type	Required	Description
FromContactId	path	Guid	Yes	Get roles available for connection from this contact
ContactId	query	Guid?	No	Get roles available for connection to this contact
ContactTypeId	query	Guid	Yes	Get roles available for connection for the specified contact type

**GetRolesForConnectionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Roles	form	List<RoleModel>	No
ResponseStatus	form	ResponseStatus	No

**RoleModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	form	Guid	Yes	Role Id
RoleName	form	string	No	Role Name
IsLicenseeRole	form	bool	No	Is the role a licensee role?
IsManageContacts	form	bool	No	Is manage contacts role?
IsPlatformRole	form	bool	No	Is the role a Platform role?
IsServiceRole	form	bool	No	Is the role a services role?
IsCustomerRole	form	bool	No	Is the role a customer role?
IsFunctionalRole	form	bool	No	Is the role a functional role?
IsRequestAutoAccepted	form	bool	No	Is the role an auto-accept role?
SuiteId	form	Guid	No	Suite that the role belongs to
SuiteName	form	string	No	Suite that the role belongs to
RecordStatus	form	string	No	'A' (Active) or 'I' (Inactive)
ObjectConnectionId	form	Guid	No	Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.

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/roles/connection/{FromContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetRolesForConnection 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>
  <ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
  <FromContactId>00000000-0000-0000-0000-000000000000</FromContactId>
</GetRolesForConnection>

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

<GetRolesForConnectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <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>
  <Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:RoleModel>
      <d2p1:IsCustomerRole>false</d2p1:IsCustomerRole>
      <d2p1:IsFunctionalRole>false</d2p1:IsFunctionalRole>
      <d2p1:IsLicenseeRole>false</d2p1:IsLicenseeRole>
      <d2p1:IsManageContacts>false</d2p1:IsManageContacts>
      <d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
      <d2p1:IsRequestAutoAccepted>false</d2p1:IsRequestAutoAccepted>
      <d2p1:IsServiceRole>false</d2p1:IsServiceRole>
      <d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
      <d2p1:RoleName>String</d2p1:RoleName>
      <d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
      <d2p1:SuiteName>String</d2p1:SuiteName>
    </d2p1:RoleModel>
  </Roles>
</GetRolesForConnectionResponse>