Platform API

<back to all web services

SearchContactsForRole

Search contacts by Name or Email Address, by Role Groups, or by Roles

Requires Authentication
The following routes are available for this service:
All Verbs/api/searchcontactsforroles
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactSummaryModel:
    # @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    contact_id: Optional[str] = None
    """
    Contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    contact_full_name: Optional[str] = None
    """
    Full name of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    email_address: Optional[str] = None
    """
    Email Address of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")
    mobile_number: Optional[str] = None
    """
    Mobile Number of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
    phone_number: Optional[str] = None
    """
    Primary Phone Number of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
    contact_type_id: Optional[str] = None
    """
    Type of contact (person, organisation etc.) linked to the profile
    """


    # @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    profile_photo_url: Optional[str] = None
    """
    Profile photo of contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    profile_photo_thumbnail_url: Optional[str] = None
    """
    Thumbnail photo of contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Profile description", Name="Description")
    description: Optional[str] = None
    """
    Profile description
    """


    # @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    employment_industry: Optional[str] = None
    """
    Employment Industry
    """


    # @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    employment_role: Optional[str] = None
    """
    Employment Role
    """


    # @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    employment_geographic_area: Optional[str] = None
    """
    Areas of Work
    """


    # @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    timezone_name: Optional[str] = None
    """
    Timezone Name
    """


    # @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    primary_address: Optional[str] = None
    """
    The primary address of the contact
    """


    # @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    is_removed_contact: bool = False
    """
    Have all connections to the contact been removed?
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchContactsForRoleResponse:
    contacts: Optional[List[ContactSummaryModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Search contacts by Name or Email Address, by Role Groups, or by Roles")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchContactsForRole:
    """
    Search contacts by Name or Email Address, by Role Groups, or by Roles
    """

    # @ApiMember(DataType="Guid", Description="Search type: by Name or Email Address, by Role Groups, or by Roles", IsRequired=true, Name="SearchBy")
    search_by: Optional[str] = None
    """
    Search type: by Name or Email Address, by Role Groups, or by Roles
    """


    # @ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")
    roles: Optional[List[str]] = None
    """
    Roles that contacts are connected to.
    """


    # @ApiMember(DataType="List<Guid>", Description="Role Groups that contacts are connected to.", Name="RoleGroups")
    role_groups: Optional[List[str]] = None
    """
    Role Groups that contacts are connected to.
    """


    # @ApiMember(DataType="string", Description="For Search by Name or Email Address, filters contact results by this text value.", Name="SearchText")
    search_text: Optional[str] = None
    """
    For Search by Name or Email Address, filters contact results by this text value.
    """


    # @ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")
    exclude_role: Optional[str] = None
    """
    Excludes contacts already connected to this role.
    """


    # @ApiMember(DataType="List<Guid>", Description="Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.", Name="ContactTypes")
    contact_types: Optional[List[str]] = None
    """
    Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.
    """


    # @ApiMember(DataType="Bool", Description="Determines whether the contact details (Email, mobile number etc.) to be returned.", Name="IncludeDetails")
    include_details: bool = False
    """
    Determines whether the contact details (Email, mobile number etc.) to be returned.
    """

Python SearchContactsForRole DTOs

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

<SearchContactsForRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </ContactTypes>
  <ExcludeRole>00000000-0000-0000-0000-000000000000</ExcludeRole>
  <IncludeDetails>false</IncludeDetails>
  <RoleGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RoleGroups>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Roles>
  <SearchBy>00000000-0000-0000-0000-000000000000</SearchBy>
  <SearchText>String</SearchText>
</SearchContactsForRole>

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

<SearchContactsForRoleResponse 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>
</SearchContactsForRoleResponse>