| 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 .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"SearchBy":"00000000-0000-0000-0000-000000000000","Roles":["00000000-0000-0000-0000-000000000000"],"RoleGroups":["00000000-0000-0000-0000-000000000000"],"SearchText":"String","ExcludeRole":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeDetails":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Contacts":[{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}