Platform API

<back to all web services

GetPagedContactsInRole

Requires Authentication
The following routes are available for this service:
All Verbs/api/contacts/paged/{RoleId}
GetPagedContactsInRole Parameters:
NameParameterData TypeRequiredDescription
RoleIdpathGuidNoGet contacts connected to the current licensee in the specified role
ContactTypesqueryList<Guid>NoGet contacts of the specified type
StatusesqueryList<Guid>YesContact statuses to search for, i.e. Real and/or Virtual
SearchTextquerystringNoText to filter contacts on. searches for a contact with matches to the string.
IncludeDetailsquerybool?NoIf you want just bare-bones contact info set this to false, if not specified it defaults to true.
PagedModel Parameters:
NameParameterData TypeRequiredDescription
PageNumberformintNoPage Number to retrieve
PageSizeformintNoNumber of records to retrieve
SortIndexformintNoIndex of field to sort results by
SortOrderformintNoSort Order - Ascending or Descending
SortOrder Enum:
Ascending
Descending
GetSlimContactsResponse Parameters:
NameParameterData TypeRequiredDescription
ContactsformList<ContactSummaryModel>No
TotalContactsformintNo
ResponseStatusformResponseStatusNo
ContactSummaryModel Parameters:
NameParameterData TypeRequiredDescription
ContactIdformGuidNoContact linked to the profile
ContactFullNameformstringNoFull name of the contact linked to the profile
EmailAddressformstringNoEmail Address of the contact linked to the profile
MobileNumberformstringNoMobile Number of the contact linked to the profile
PhoneNumberformstringNoPrimary Phone Number of the contact linked to the profile
ContactTypeIdformstringNoType of contact (person, organisation etc.) linked to the profile
ProfilePhotoUrlformstringNoProfile photo of contact linked to the profile
ProfilePhotoThumbnailUrlformstringNoThumbnail photo of contact linked to the profile
DescriptionformstringNoProfile description
EmploymentIndustryformstringNoEmployment Industry
EmploymentRoleformstringNoEmployment Role
EmploymentGeographicAreaformstringNoAreas of Work
TimezoneNamequerystringNoTimezone Name
PrimaryAddressquerystringNoThe primary address of the contact
IsRemovedContactformboolNoHave all connections to the contact been removed?

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

<GetPagedContactsInRole 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>
  <ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </ContactTypes>
  <IncludeDetails>false</IncludeDetails>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <SearchText>String</SearchText>
  <Statuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Statuses>
</GetPagedContactsInRole>

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

<GetSlimContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Contacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ContactSummaryModel>
      <d2p1:ContactFullName>String</d2p1:ContactFullName>
      <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
      <d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
      <d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
      <d2p1:EmploymentRole>String</d2p1:EmploymentRole>
      <d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
      <d2p1:MobileNumber>String</d2p1:MobileNumber>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
      <d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
      <d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
      <d2p1:TimezoneName>String</d2p1:TimezoneName>
    </d2p1:ContactSummaryModel>
  </Contacts>
  <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>
  <TotalContacts>0</TotalContacts>
</GetSlimContactsResponse>