| All Verbs | /api/contacts/{RoleId} | ||
|---|---|---|---|
| All Verbs | /api/contacts/managers | ||
| All Verbs | /api/contacts/supervisors | ||
| All Verbs | /api/contacts/customerservicereps |
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 UserProfileSummaryModel:
# @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
user_profile_id: Optional[str] = None
"""
User Profile Id
"""
# @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
user_id: Optional[str] = None
"""
User linked to the profile
"""
# @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="User linked to the profile", Name="UserName")
user_name: Optional[str] = None
"""
User linked to the profile
"""
# @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
profile_name: Optional[str] = None
"""
User Profile Name
"""
# @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="Email signature of the contact linked to the profile", Name="EmailSignature")
email_signature: Optional[str] = None
"""
Email signature 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="Phone number of the contact linked to the profile", Name="PhoneNumber")
phone_number: Optional[str] = None
"""
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="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")
contact_type_name: Optional[str] = None
"""
Type of contact (person, organisation etc.) linked to the profile
"""
# @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
first_name: Optional[str] = None
"""
First name of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
surname: Optional[str] = None
"""
Surname of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
title: Optional[str] = None
"""
Title of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
legal_name: Optional[str] = None
"""
Legal name of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
trading_name: Optional[str] = None
"""
Trading name of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
abn: Optional[str] = None
"""
Australian Business Number
"""
# @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
acn: Optional[str] = None
"""
Australian Company Number
"""
# @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
arbn: Optional[str] = None
"""
Australian Registered Body Number
"""
# @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
gst_registered: bool = False
"""
Indicates if the Contact is registered for GST.
"""
# @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
esl: bool = False
"""
True if english is a secondary language for the contact.
"""
# @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
language: Optional[str] = None
"""
Language that is the primary language for the contact.
"""
# @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
interpreter_required: bool = False
"""
True if an interpreter is required.
"""
# @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
licensee_notes: Optional[str] = None
"""
Licensee specific notes about the contact.
"""
# @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="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
profile_image_id: Optional[str] = None
"""
Profile photo id 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="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
timezone: Optional[str] = None
"""
The contacts timezone.
"""
# @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="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
is_active_contact: bool = False
"""
Is this an active contact? Or an inactive contact (deleted account)?
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocationCoordinatesModel:
# @ApiMember(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", ParameterType="query")
latitude: float = 0.0
"""
The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
"""
# @ApiMember(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", ParameterType="query")
longitude: float = 0.0
"""
The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
"""
# @ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")
altitude: Optional[float] = None
"""
The altitude of an address - the altitude above sea level."
"""
# @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
accuracy: Optional[float] = None
"""
Accuracy of the latitude and longitude.
"""
# @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
altitude_accuracy: Optional[float] = None
"""
Accurancy of the Altitude.
"""
# @ApiMember(Description="Direction you are heading.", ParameterType="query")
heading: Optional[float] = None
"""
Direction you are heading.
"""
# @ApiMember(Description="Speed you are going.", ParameterType="query")
speed: Optional[float] = None
"""
Speed you are going.
"""
# @ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")
vertical_speed: Optional[float] = None
"""
Speed your altitude is ascending/descending at.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressModel:
# @ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="body")
distance_away: float = 0.0
"""
The distance between this project and another specified set of gps coordinates.
"""
# @ApiMember(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", Name="Latitude", ParameterType="body")
latitude: float = 0.0
"""
The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
"""
# @ApiMember(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", Name="Longitude", ParameterType="body")
longitude: float = 0.0
"""
The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
"""
# @ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="body")
address_format_id: Optional[str] = None
"""
Address Format Id Guid - this will be determined by the service.
"""
# @ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="body")
suburb_id: Optional[str] = None
"""
Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
"""
# @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
suburb_name: Optional[str] = None
"""
The suburb name.
"""
# @ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")
state_short_name: Optional[str] = None
"""
The shortened State Name e.g Vic for Victoria.
"""
# @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
post_code: Optional[str] = None
"""
The suburb postcode.
"""
# @ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="body")
country_id: Optional[str] = None
"""
Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
"""
# @ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="body")
country_name: Optional[str] = None
"""
the name of the country the address is within.
"""
# @ApiMember(Description="ISO Country Code.", ParameterType="query")
iso_country_code: Optional[str] = None
"""
ISO Country Code.
"""
# @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
lot_number: Optional[str] = None
"""
The address Lot number.
"""
# @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
sub_unit: Optional[str] = None
"""
The address Sub Unit number.
"""
# @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
building_number: Optional[str] = None
"""
The address building number.
"""
# @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
street_number: Optional[str] = None
"""
The address street number.
"""
# @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")
street_name: Optional[str] = None
"""
The address street name including street type.
"""
# @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
address_line_one: Optional[str] = None
"""
A formatted address Line 1.
"""
# @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
address_line_two: Optional[str] = None
"""
A formatted address Line 2.
"""
# @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
address_full: Optional[str] = None
"""
The full address string.
"""
# @ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="body")
is_physical: Optional[bool] = None
"""
True if the address is a physical location.
"""
# @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
notes: Optional[str] = None
"""
Notes about the address.
"""
# @ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="body")
auto_map_coordinates: Optional[bool] = None
"""
If true, the address is eligible for having its coordinates calculated/updated.
"""
# @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
location_coordinates: Optional[LocationCoordinatesModel] = None
"""
Location Coordinates for the address.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GeoEstateStageModel:
geo_estate_stage_id: Optional[str] = None
geo_estate_id: Optional[str] = None
name: Optional[str] = None
notes: Optional[str] = None
record_status: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GeoEstateModel:
geo_estate_id: Optional[str] = None
name: Optional[str] = None
notes: Optional[str] = None
developer_contact_id: Optional[str] = None
developer_name: Optional[str] = None
developer_profile_photo_url: Optional[str] = None
developer_profile_photo_thumbnail: Optional[str] = None
record_status: Optional[str] = None
stages: Optional[List[GeoEstateStageModel]] = None
current_estate_stage_id: Optional[str] = None
current_estate_stage_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GeoLocationModel:
# @ApiMember(DataType="Guid", Description="The location id", Name="GeoLocationId", ParameterType="query")
geo_location_id: Optional[str] = None
"""
The location id
"""
# @ApiMember(DataType="Guid", Description="The state id", Name="StateId", ParameterType="query")
state_id: Optional[str] = None
"""
The state id
"""
# @ApiMember(DataType="string", Description="The state name", Name="StateName", ParameterType="query")
state_name: Optional[str] = None
"""
The state name
"""
# @ApiMember(DataType="Guid", Description="The suburb id", Name="SuburbId", ParameterType="query")
suburb_id: Optional[str] = None
"""
The suburb id
"""
# @ApiMember(DataType="string", Description="The suburb name", Name="SuburbName", ParameterType="query")
suburb_name: Optional[str] = None
"""
The suburb name
"""
# @ApiMember(DataType="Guid", Description="The country id", Name="CountryId", ParameterType="query")
country_id: Optional[str] = None
"""
The country id
"""
# @ApiMember(DataType="string", Description="The country name", Name="CountryName", ParameterType="query")
country_name: Optional[str] = None
"""
The country name
"""
# @ApiMember(DataType="string", Description="The lot number", Name="LotNumber", ParameterType="query")
lot_number: Optional[str] = None
"""
The lot number
"""
# @ApiMember(DataType="string", Description="The unit number", Name="SubUnit", ParameterType="query")
sub_unit: Optional[str] = None
"""
The unit number
"""
# @ApiMember(DataType="string", Description="The building number", Name="BuildingNumber", ParameterType="query")
building_number: Optional[str] = None
"""
The building number
"""
# @ApiMember(DataType="string", Description="PO Box Number", Name="PostalDeliveryNumber", ParameterType="query")
postal_delivery_number: Optional[str] = None
"""
PO Box Number
"""
# @ApiMember(DataType="string", Description="The Street Number", Name="StreetNumber", ParameterType="query")
street_number: Optional[str] = None
"""
The Street Number
"""
# @ApiMember(DataType="string", Description="The Street name", Name="StreetName", ParameterType="query")
street_name: Optional[str] = None
"""
The Street name
"""
# @ApiMember(DataType="string", Description="Address Line ONe", Name="AddressLineOne", ParameterType="query")
address_line_one: Optional[str] = None
"""
Address Line ONe
"""
# @ApiMember(DataType="string", Description="Address Line Two", Name="AddressLineTwo", ParameterType="query")
address_line_two: Optional[str] = None
"""
Address Line Two
"""
# @ApiMember(DataType="string", Description="Post code", Name="PostCode", ParameterType="query")
post_code: Optional[str] = None
"""
Post code
"""
# @ApiMember(DataType="bool", Description="Is location physical", Name="IsPhysical", ParameterType="query")
is_physical: bool = False
"""
Is location physical
"""
# @ApiMember(DataType="string", Description="Notes about the location", Name="Notes", ParameterType="query")
notes: Optional[str] = None
"""
Notes about the location
"""
# @ApiMember(DataType="string", Description="The address in full", Name="AddressFull", ParameterType="query")
address_full: Optional[str] = None
"""
The address in full
"""
# @ApiMember(DataType="Guid", Description="Address format id.", Name="AddressFormatId", ParameterType="query")
address_format_id: Optional[str] = None
"""
Address format id.
"""
# @ApiMember(DataType="double", Description="Latitude", Name="Latitude", ParameterType="query")
latitude: float = 0.0
"""
Latitude
"""
# @ApiMember(DataType="double", Description="Longitude", Name="Longitude", ParameterType="query")
longitude: float = 0.0
"""
Longitude
"""
# @ApiMember(DataType="Guid?", Description="Timezone Id", Name="Timezone", ParameterType="query")
timezone: Optional[str] = None
"""
Timezone Id
"""
estate: Optional[GeoEstateModel] = None
geo_estate_id: Optional[str] = None
geo_estate_stage_id: Optional[str] = None
geo_estate_stage_name: Optional[str] = None
ignore_validation: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactAddressModel:
# @ApiMember(DataType="GeoLocationModel", Description="Location Details.", Name="Location", ParameterType="query")
location: Optional[GeoLocationModel] = None
"""
Location Details.
"""
# @ApiMember(DataType="bool", Description="Is address postal.", Name="IsPostal", ParameterType="query")
is_postal: bool = False
"""
Is address postal.
"""
# @ApiMember(DataType="bool", Description="Is address primary.", Name="IsPrimaryLocation", ParameterType="query")
is_primary_location: bool = False
"""
Is address primary.
"""
# @ApiMember(DataType="bool", Description="Is address registered.", Name="IsRegisteredLocation", ParameterType="query")
is_registered_location: bool = False
"""
Is address registered.
"""
# @ApiMember(DataType="Guid", Description="Contact Address Id.", Name="ContactAddressId", ParameterType="query")
contact_address_id: Optional[str] = None
"""
Contact Address Id.
"""
# @ApiMember(DataType="string", Description="Contact Address Suburb Name.", Name="SuburbName", ParameterType="query")
suburb_name: Optional[str] = None
"""
Contact Address Suburb Name.
"""
# @ApiMember(DataType="string", Description="Contact Address Street Name.", Name="StateName", ParameterType="query")
state_name: Optional[str] = None
"""
Contact Address Street Name.
"""
# @ApiMember(DataType="string", Description="Contact Country Name.", Name="CountryName", ParameterType="query")
country_name: Optional[str] = None
"""
Contact Country Name.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhoneModel:
# @ApiMember(DataType="string", Description="Phone Country Code.", Name="CountryCode", ParameterType="query")
country_code: Optional[str] = None
"""
Phone Country Code.
"""
# @ApiMember(DataType="string", Description="Phone Area Code.", Name="AreaCode", ParameterType="query")
area_code: Optional[str] = None
"""
Phone Area Code.
"""
# @ApiMember(DataType="string", Description="Phone Local Number.", Name="LocalNumber", ParameterType="query")
local_number: Optional[str] = None
"""
Phone Local Number.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactDetailModel:
# @ApiMember(DataType="Guid", Description="Contact Method Id", Name="ContactMethodId", ParameterType="query")
contact_method_id: Optional[str] = None
"""
Contact Method Id
"""
# @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="query")
contact_method_name: Optional[str] = None
"""
Contact Method Name
"""
# @ApiMember(DataType="ContactAddressModel", Description="Contact Address Details", Name="ContactAddress", ParameterType="query")
contact_address: Optional[ContactAddressModel] = None
"""
Contact Address Details
"""
# @ApiMember(DataType="PhoneModel", Description="Contact Phone Details", Name="ContactPhone", ParameterType="query")
contact_phone: Optional[PhoneModel] = None
"""
Contact Phone Details
"""
# @ApiMember(DataType="Guid", Description="Country id", Name="CountryId", ParameterType="query")
country_id: Optional[str] = None
"""
Country id
"""
# @ApiMember(DataType="string", Description="Contact Details", Name="ContactDetails", ParameterType="query")
contact_details: Optional[str] = None
"""
Contact Details
"""
# @ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")
notes: Optional[str] = None
"""
Notes
"""
# @ApiMember(DataType="string", Description="Contact Details Code", Name="ContactDetailsCode", ParameterType="query")
contact_details_code: Optional[str] = None
"""
Contact Details Code
"""
# @ApiMember(DataType="int", Description="Order of Contact Method Id", Name="OrderContactMethod", ParameterType="query")
order_contact_method: int = 0
"""
Order of Contact Method Id
"""
# @ApiMember(DataType="bool", Description="Contact Method Id", Name="IsPrimaryContactMethod", ParameterType="query")
is_primary_contact_method: bool = False
"""
Contact Method Id
"""
# @ApiMember(DataType="bool", Description="Is contact details an address", Name="IsAddress", ParameterType="query")
is_address: bool = False
"""
Is contact details an address
"""
# @ApiMember(DataType="Guid", Description="Contact Contact Detail Id", Name="ContactContactDetailId", ParameterType="query")
contact_contact_detail_id: Optional[str] = None
"""
Contact Contact Detail Id
"""
# @ApiMember(DataType="Guid", Description="Contact Id", Name="ContactId", ParameterType="query")
contact_id: Optional[str] = None
"""
Contact Id
"""
# @ApiMember(DataType="Guid", Description="Contact Details Id", Name="ContactDetailId", ParameterType="query")
contact_detail_id: Optional[str] = None
"""
Contact Details Id
"""
# @ApiMember(DataType="bool", Description="Is contact details a primary location", Name="IsPrimaryLocation", ParameterType="query")
is_primary_location: bool = False
"""
Is contact details a primary location
"""
# @ApiMember(DataType="bool", Description="Is contact details a registered location", Name="IsRegisteredLocation", ParameterType="query")
is_registered_location: bool = False
"""
Is contact details a registered location
"""
# @ApiMember(DataType="bool", Description="Is contact details a postal address", Name="IsPostal", ParameterType="query")
is_postal: bool = False
"""
Is contact details a postal address
"""
# @ApiMember(DataType="bool", Description="Is contact details a phone number", Name="IsPhone", ParameterType="query")
is_phone: bool = False
"""
Is contact details a phone number
"""
# @ApiMember(DataType="Guid", Description="Email Signature Id", Name="EmailSignatureId", ParameterType="query")
email_signature_id: Optional[str] = None
"""
Email Signature Id
"""
# @ApiMember(DataType="string", Description="Email Signature HTML", Name="EmailSignatureHTML", ParameterType="query")
email_signature_h_t_m_l: Optional[str] = None
"""
Email Signature HTML
"""
# @ApiMember(DataType="string", Description="Email Signature Text", Name="EmailSignatureText", ParameterType="query")
email_signature_text: Optional[str] = None
"""
Email Signature Text
"""
# @ApiMember(DataType="string", Description="API Key from Framework", Name="ApiFrameworkAlternateKey", ParameterType="query")
api_framework_alternate_key: Optional[str] = None
"""
API Key from Framework
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfileModel(UserProfileSummaryModel):
# @ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query")
birth_date: Optional[datetime.datetime] = None
"""
Contact Date of Birth (when person type)
"""
# @ApiMember(DataType="string", Description="Contact marital status (when person type)", Name="MaritalStatusName", ParameterType="query")
marital_status_name: Optional[str] = None
"""
Contact marital status (when person type)
"""
# @ApiMember(DataType="string", Description="Contact gender (when person type)", Name="GenderName", ParameterType="query")
gender_name: Optional[str] = None
"""
Contact gender (when person type)
"""
# @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
gender_id: Optional[str] = None
"""
The Gender Guid of the contact.
"""
# @ApiMember(DataType="List<ContactDetailModel>", Description="All contact details of the contact", Name="ContactDetails", ParameterType="query")
contact_details: Optional[List[ContactDetailModel]] = None
"""
All contact details of the contact
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Street Address", Name="PrimaryStreetAddress ")
primary_street_address: Optional[ContactDetailModel] = None
"""
Primary Street Address
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Postal Address", Name="PrimaryPostalAddress ")
primary_postal_address: Optional[ContactDetailModel] = None
"""
Primary Postal Address
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Registered Address", Name="PrimaryRegisteredAddress ")
primary_registered_address: Optional[ContactDetailModel] = None
"""
Primary Registered Address
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Email Address", Name="PrimaryEmail ")
primary_email: Optional[ContactDetailModel] = None
"""
Primary Email Address
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Mobile Number", Name="PrimaryMobile")
primary_mobile: Optional[ContactDetailModel] = None
"""
Primary Mobile Number
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Non-Mobile Number", Name="PrimaryPhone")
primary_phone: Optional[ContactDetailModel] = None
"""
Primary Non-Mobile Number
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Fax Number", Name="PrimaryFax")
primary_fax: Optional[ContactDetailModel] = None
"""
Primary Fax Number
"""
# @ApiMember(DataType="ContactDetail", Description="Primary Web Address", Name="PrimaryWeb")
primary_web: Optional[ContactDetailModel] = None
"""
Primary Web Address
"""
# @ApiMember(DataType="ContactDetail", Description="Social Media Twitter", Name="SocialMediaTwitter")
social_media_twitter: Optional[ContactDetailModel] = None
"""
Social Media Twitter
"""
# @ApiMember(DataType="ContactDetail", Description="Social Media Facebook", Name="SocialMediaFacebook")
social_media_facebook: Optional[ContactDetailModel] = None
"""
Social Media Facebook
"""
# @ApiMember(DataType="ContactDetail", Description="Social Media Instagram", Name="SocialMediaInstagram")
social_media_instagram: Optional[ContactDetailModel] = None
"""
Social Media Instagram
"""
# @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?
"""
# @ApiMember(DataType="bool", Description="True if this is the users default profile.", Name="IsDefault", ParameterType="query")
is_default: bool = False
"""
True if this is the users default profile.
"""
# @ApiMember(DataType="bool", Description="True if the users email on this profile can be edited.", Name="IsEmailEditable", ParameterType="query")
is_email_editable: bool = False
"""
True if the users email on this profile can be edited.
"""
# @ApiMember(DataType="string", Description="Primary image Content sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContent")
primary_image_content: Optional[str] = None
"""
Primary image Content sent as a file stream contents (if not attached to the request)
"""
# @ApiMember(DataType="string", Description="Primary image Content type sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContentType")
primary_image_content_type: Optional[str] = None
"""
Primary image Content type sent as a file stream contents (if not attached to the request)
"""
# @ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName")
primary_image_file_name: Optional[str] = None
"""
Primary image file name
"""
# @ApiResponse(Description="Get contacts connected to the current licensee in the specified role and response status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactsInRoleResponse:
user_profiles: Optional[List[UserProfileModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get contacts connected to the current licensee in the specified role")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactsInRole:
"""
Get contacts connected to the current licensee in the specified role
"""
# @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
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactDetailModel:
# @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
contact_method_id: Optional[str] = None
"""
Id of the Contact Method
"""
# @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
contact_method_name: Optional[str] = None
"""
Contact Method Name
"""
# @ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
contact_address: Optional[ContactAddressModel] = None
"""
If the contact method is an address, this will contain the address details.
"""
# @ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
contact_phone: Optional[PhoneModel] = None
"""
If the contact method is a phone, this will contain the phone details
"""
# @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
country_id: Optional[str] = None
"""
Id of the country
"""
# @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
contact_details: Optional[str] = None
"""
A summary string representing the contact details
"""
# @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
notes: Optional[str] = None
"""
Notes about the contact details
"""
# @ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
contact_details_code: Optional[str] = None
"""
Area Code if contact details are a phone number
"""
# @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
order_contact_method: int = 0
"""
Order number of the contact method
"""
# @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
is_primary_contact_method: bool = False
"""
True if this is the primary contact method
"""
# @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
is_address: bool = False
"""
True if this contact method is an address
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactAddressModel:
# @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
address: Optional[AddressModel] = None
"""
Address Details
"""
# @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
is_postal: bool = False
"""
True if this is a postal address.
"""
# @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
is_primary_location: bool = False
"""
True if this is the primary address.
"""
# @ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")
is_registered_location: bool = False
"""
True if this address is the registered tax address.
"""
# @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
suburb_name: Optional[str] = None
"""
Suburb Name
"""
# @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
state_name: Optional[str] = None
"""
State Name
"""
# @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
country_name: Optional[str] = None
"""
Country Name
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhoneModel:
# @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
country_code: Optional[str] = None
"""
Country Code
"""
# @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
area_code: Optional[str] = None
"""
Area Code
"""
# @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
local_number: Optional[str] = None
"""
Local Number
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/{RoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UserProfiles:
[
{
BirthDate: 0001-01-01,
MaritalStatusName: String,
GenderName: String,
GenderId: 00000000000000000000000000000000,
ContactDetails:
[
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
}
],
PrimaryStreetAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryPostalAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryRegisteredAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryEmail:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryMobile:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryPhone:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryFax:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryWeb:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaTwitter:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaFacebook:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaInstagram:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
IsRemovedContact: False,
IsDefault: False,
IsEmailEditable: False,
PrimaryImageContent: String,
PrimaryImageContentType: String,
PrimaryImageFileName: String,
UserName: String,
ProfileName: String,
ContactFullName: String,
EmailAddress: String,
EmailSignature: String,
MobileNumber: String,
PhoneNumber: String,
ContactTypeName: String,
FirstName: String,
Surname: String,
Title: String,
LegalName: String,
TradingName: String,
Abn: String,
Acn: String,
Arbn: String,
GstRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsActiveContact: False
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}