Platform API

GetContactRoleDetails

Get details of the specified contact role, including details of the contacts and organisations sharing it

The following routes are available for this service:
All Verbs	/api/contactrole/{ContactRoleId}

**GetContactRoleDetails** Parameters:
Name	Parameter	Data Type	Required	Description
ContactRoleId	query	Guid	Yes	The Contact Role Guid. Records retrieved will belong to this contact.
SearchText	query	string	No	Text filter

**PagedModel** Parameters:
Name	Parameter	Data Type	Required	Description
PageNumber	form	int	No	Page Number to retrieve
PageSize	form	int	No	Number of records to retrieve
SortIndex	form	int	No	Index of field to sort results by
SortOrder	form	int	No	Sort Order - Ascending or Descending

**SortOrder** Enum:
Ascending
Descending

**GetContactRoleDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactRole	form	ViewRoleModel	No
ResponseStatus	form	ResponseStatus	No

**ViewRoleModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	form	Guid	Yes	Role Id
RoleName	form	string	No	Role Name
RoleConnectionDefinitionId	form	Guid	No	Role Connection Definition Id
ContactTypes	form	List	No	Contact Types the Role applies to
RequireContactsToAccept	form	bool	No	Does the role require contacts to accept it?
IsPlatformRole	form	bool	No
CanAddContacts	form	bool	No
CanShareRole	form	bool	No
CanEditRole	form	bool	No
CanEditContactTypes	form	bool	No
Contacts	form	List<UserProfileSummaryModel>	No
ShareDetails	form	IList<ObjectShareModel>	No
ListItemFilters	form	List<ListItemFilterModel>	No
ContactIdOwner	form	Guid	No
TotalItemCount	form	int	No

**UserProfileSummaryModel** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	form	Guid	No	User Profile Id
UserId	form	Guid	No	User linked to the profile
ContactId	form	Guid	No	Contact linked to the profile
UserName	form	string	No	User linked to the profile
ProfileName	form	string	No	User Profile Name
ContactFullName	form	string	No	Full name of the contact linked to the profile
EmailAddress	form	string	No	Email Address of the contact linked to the profile
EmailSignature	form	string	No	Email signature of the contact linked to the profile
MobileNumber	form	string	No	Mobile number of the contact linked to the profile
PhoneNumber	form	string	No	Phone number of the contact linked to the profile
ContactTypeId	form	string	No	Type of contact (person, organisation etc.) linked to the profile
ContactTypeName	form	string	No	Type of contact (person, organisation etc.) linked to the profile
FirstName	form	string	No	First name of the contact linked to the profile
Surname	form	string	No	Surname of the contact linked to the profile
Title	form	string	No	Title of contact linked to the profile
LegalName	form	string	No	Legal name of contact linked to the profile
TradingName	form	string	No	Trading name of contact linked to the profile
Abn	query	string	No	Australian Business Number
Acn	query	string	No	Australian Company Number
Arbn	query	string	No	Australian Registered Body Number
GstRegistered	query	bool	No	Indicates if the Contact is registered for GST.
ESL	query	bool	No	True if english is a secondary language for the contact.
Language	query	string	No	Language that is the primary language for the contact.
InterpreterRequired	query	bool	No	True if an interpreter is required.
LicenseeNotes	query	string	No	Licensee specific notes about the contact.
ProfilePhotoUrl	form	string	No	Profile photo of contact linked to the profile
ProfilePhotoThumbnailUrl	form	string	No	Thumbnail photo of contact linked to the profile
ProfileImageId	form	Guid	No	Profile photo id of contact linked to the profile
Description	form	string	No	Profile description
EmploymentIndustry	form	string	No	Employment Industry
EmploymentRole	form	string	No	Employment Role
EmploymentGeographicArea	form	string	No	Areas of Work
Timezone	query	Guid	No	The contacts timezone.
TimezoneName	query	string	No	Timezone Name
PrimaryAddress	query	string	No	The primary address of the contact
IsActiveContact	form	bool	No	Is this an active contact? Or an inactive contact (deleted account)?

**ObjectShareModel** Parameters:
Name	Parameter	Data Type	Required
ObjectShareId	form	Guid	No
ObjectId	form	Guid	No
ObjectName	form	string	No
Name	form	string	No
Description	form	string	No
Reference	form	string	No
ContactId	form	Guid	No
ContactName	form	string	No
ContactType	form	string	No
ContactImageUrlPrimary	form	string	No
ContactImageUrlPrimaryThmbnail	form	string	No
ShareStatusId	form	Guid	No
ShareStatusName	form	string	No

**ListItemFilterModel** Parameters:
Name	Parameter	Data Type	Required
ListItemFilterId	form	Guid	No
FilterName	form	string	No
ListId	form	Guid	No
ListItemId	form	Guid	No
ListItemIsInFilter	form	bool	No

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

<GetContactRoleDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageSize>
  <SortIndex xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</SortIndex>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">Ascending</SortOrder>
  <ContactRoleId>00000000-0000-0000-0000-000000000000</ContactRoleId>
  <SearchText>String</SearchText>
</GetContactRoleDetails>

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

<GetContactRoleDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRole xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:PageNumber>0</d2p1:PageNumber>
    <d2p1:PageSize>0</d2p1:PageSize>
    <d2p1:SortIndex>0</d2p1:SortIndex>
    <d2p1:SortOrder>Ascending</d2p1:SortOrder>
    <d2p1:CanAddContacts>false</d2p1:CanAddContacts>
    <d2p1:CanEditContactTypes>false</d2p1:CanEditContactTypes>
    <d2p1:CanEditRole>false</d2p1:CanEditRole>
    <d2p1:CanShareRole>false</d2p1:CanShareRole>
    <d2p1:ContactIdOwner>00000000-0000-0000-0000-000000000000</d2p1:ContactIdOwner>
    <d2p1:ContactTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:ContactTypes>
    <d2p1:Contacts>
      <d2p1:UserProfileSummaryModel>
        <d2p1:Abn>String</d2p1:Abn>
        <d2p1:Acn>String</d2p1:Acn>
        <d2p1:Arbn>String</d2p1:Arbn>
        <d2p1:ContactFullName>String</d2p1:ContactFullName>
        <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
        <d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
        <d2p1:ContactTypeName>String</d2p1:ContactTypeName>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:ESL>false</d2p1:ESL>
        <d2p1:EmailAddress>String</d2p1:EmailAddress>
        <d2p1:EmailSignature>String</d2p1:EmailSignature>
        <d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
        <d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
        <d2p1:EmploymentRole>String</d2p1:EmploymentRole>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:GstRegistered>false</d2p1:GstRegistered>
        <d2p1:InterpreterRequired>false</d2p1:InterpreterRequired>
        <d2p1:IsActiveContact>false</d2p1:IsActiveContact>
        <d2p1:Language>String</d2p1:Language>
        <d2p1:LegalName>String</d2p1:LegalName>
        <d2p1:LicenseeNotes>String</d2p1:LicenseeNotes>
        <d2p1:MobileNumber>String</d2p1:MobileNumber>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
        <d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
        <d2p1:ProfileImageId>00000000-0000-0000-0000-000000000000</d2p1:ProfileImageId>
        <d2p1:ProfileName>String</d2p1:ProfileName>
        <d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
        <d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
        <d2p1:Surname>String</d2p1:Surname>
        <d2p1:Timezone>00000000-0000-0000-0000-000000000000</d2p1:Timezone>
        <d2p1:TimezoneName>String</d2p1:TimezoneName>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:TradingName>String</d2p1:TradingName>
        <d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
        <d2p1:UserName>String</d2p1:UserName>
        <d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
      </d2p1:UserProfileSummaryModel>
    </d2p1:Contacts>
    <d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
    <d2p1:ListItemFilters>
      <d2p1:ListItemFilterModel>
        <d2p1:FilterName>String</d2p1:FilterName>
        <d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
        <d2p1:ListItemFilterId>00000000-0000-0000-0000-000000000000</d2p1:ListItemFilterId>
        <d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
        <d2p1:ListItemIsInFilter>false</d2p1:ListItemIsInFilter>
      </d2p1:ListItemFilterModel>
    </d2p1:ListItemFilters>
    <d2p1:RequireContactsToAccept>false</d2p1:RequireContactsToAccept>
    <d2p1:RoleConnectionDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:RoleConnectionDefinitionId>
    <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
    <d2p1:RoleName>String</d2p1:RoleName>
    <d2p1:ShareDetails i:nil="true" />
    <d2p1:TotalItemCount>0</d2p1:TotalItemCount>
  </ContactRole>
  <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>
</GetContactRoleDetailsResponse>