| All Verbs | /api/contacts/paged/{RoleId} |
|---|
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
class SortOrder(str, Enum):
ASCENDING = 'Ascending'
DESCENDING = 'Descending'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagedModel:
# @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
page_number: int = 0
"""
Page Number to retrieve
"""
# @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
page_size: int = 0
"""
Number of records to retrieve
"""
# @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
sort_index: int = 0
"""
Index of field to sort results by
"""
# @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
sort_order: Optional[SortOrder] = None
"""
Sort Order - Ascending or Descending
"""
@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?
"""
# @ApiResponse(Description="Contacts connected to contact by criteria, returning minimal number of columns, and response status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSlimContactsResponse:
contacts: Optional[List[ContactSummaryModel]] = None
total_contacts: int = 0
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPagedContactsInRole(PagedModel):
# @ApiMember(Description="Get contacts connected to the current licensee in the specified role", Name="RoleId")
role_id: Optional[str] = None
"""
Get contacts connected to the current licensee in the specified role
"""
# @ApiMember(Description="Get contacts of the specified type", Name="ContactTypes")
contact_types: Optional[List[str]] = None
"""
Get contacts of the specified type
"""
# @ApiMember(DataType="List<Guid>", Description="Contact statuses to search for, i.e. Real and/or Virtual", IsRequired=true, Name="Statuses")
statuses: List[str] = field(default_factory=list)
"""
Contact statuses to search for, i.e. Real and/or Virtual
"""
# @ApiMember(DataType="string", Description="Text to filter contacts on. searches for a contact with matches to the string.", Name="SearchText")
search_text: Optional[str] = None
"""
Text to filter contacts on. searches for a contact with matches to the string.
"""
# @ApiMember(DataType="bool?", Description="If you want just bare-bones contact info set this to false, if not specified it defaults to true.", Name="IncludeDetails")
include_details: Optional[bool] = None
"""
If you want just bare-bones contact info set this to false, if not specified it defaults to true.
"""
Python GetPagedContactsInRole DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>