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 ContactRole:
# @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within PSTPF.", Name="RoleId", ParameterType="body")
role_id: Optional[str] = None
"""
Guid of the Role List Item object within PSTPF.
"""
# @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system.", Name="AlternateKey", ParameterType="body")
alternate_key: Optional[str] = None
"""
The unique key that represents the role type on the external system.
"""
@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 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
"""
@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 SubscriptionContactModel:
# @ApiMember(DataType="Guid", Description="Guid of the contact object within PSTPF.", Name="ContactId", ParameterType="body")
contact_id: Optional[str] = None
"""
Guid of the contact object within PSTPF.
"""
# @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within PSTPF.", Name="ContactType", ParameterType="body")
contact_type: Optional[str] = None
"""
Guid of the Contact Type List Item object within PSTPF.
"""
# @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within PSTPF.", Name="MaritalStatus", ParameterType="body")
marital_status: Optional[str] = None
"""
Guid of the Marital Status List Item object within PSTPF.
"""
# @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within PSTPF.", Name="Gender", ParameterType="body")
gender: Optional[str] = None
"""
Guid of the Gender List Item object within PSTPF.
"""
# @ApiMember(DataType="string", Description="The first given name for the contact. Applies to a person contact type.", Name="FirstName", ParameterType="body")
first_name: Optional[str] = None
"""
The first given name for the contact. Applies to a person contact type.
"""
# @ApiMember(DataType="string", Description="The middle name(s) for the contact. Applies to a person contact type.", Name="MiddleName", ParameterType="body")
middle_name: Optional[str] = None
"""
The middle name(s) for the contact. Applies to a person contact type.
"""
# @ApiMember(DataType="string", Description="The surname for the contact. Applies to a person contact type.", Name="Surname", ParameterType="body")
surname: Optional[str] = None
"""
The surname for the contact. Applies to a person contact type.
"""
# @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="body")
full_name: Optional[str] = None
"""
The full name for the contact.
"""
# @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="body")
short_name: Optional[str] = None
"""
A short name for the contact.
"""
# @ApiMember(DataType="DateTime?", Description="The birth date for the contact. Applies to a person contact type.", Name="BirthDate", ParameterType="body")
birth_date: Optional[datetime.datetime] = None
"""
The birth date for the contact. Applies to a person contact type.
"""
# @ApiMember(DataType="string", Description="The title for the contact. Applies to a person contact type.", Name="Title", ParameterType="body")
title: Optional[str] = None
"""
The title for the contact. Applies to a person contact type.
"""
# @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="body")
salutation: Optional[str] = None
"""
A salutation for the contact.
"""
# @ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="body")
abn: Optional[str] = None
"""
The A.B.N for the contact.
"""
# @ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="body")
acn: Optional[str] = None
"""
The A.C.N for the contact.
"""
# @ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="body")
arbn: Optional[str] = None
"""
The A.R.B.N for the contact.
"""
# @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="body")
trading_name: Optional[str] = None
"""
A trading name for the contact.
"""
# @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="body")
legal_name: Optional[str] = None
"""
A legal name for the contact.
"""
# @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="body")
notes: Optional[str] = None
"""
Any notes/description for the contact.
"""
# @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="body")
employment_industry: Optional[str] = None
"""
Contact Employment Industry.
"""
# @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="body")
employment_role: Optional[str] = None
"""
Contact Employment Role.
"""
# @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="body")
employment_geographic_area: Optional[str] = None
"""
Contact Employment Geographic Area.
"""
# @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="body")
drivers_licence: Optional[str] = None
"""
The Contacts Drivers Licence Number
"""
# @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST", Name="GstRegistered", ParameterType="body")
gst_registered: bool = False
"""
Indicates if the Contact is registered for GST
"""
# @ApiMember(DataType="string", Description="The status of the contact in PSTPF", Name="RecordStatus", ParameterType="body")
record_status: Optional[str] = None
"""
The status of the contact in PSTPF
"""
# @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", Name="ContactRoles", ParameterType="body")
contact_roles: Optional[List[ContactRole]] = None
"""
A list of roles this contact has.
"""
# @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact.", Name="ContactDetails", ParameterType="body")
contact_details: Optional[List[ContactDetailModel]] = None
"""
A list of the contact details for the contact.
"""
# @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="body")
custom_content_x_m_l: Optional[str] = None
"""
Custom Content XML for the contact.
"""
# @ApiMember(DataType="string", Description="URL to the Primary Image.", Name="BlobImageURLPrimary", ParameterType="body")
blob_image_u_r_l_primary: Optional[str] = None
"""
URL to the Primary Image.
"""
# @ApiMember(DataType="string", Description="URL to the Primary Image thumbnail.", Name="BlobImageURLPrimaryThumbnail", ParameterType="body")
blob_image_u_r_l_primary_thumbnail: Optional[str] = None
"""
URL to the Primary Image thumbnail.
"""
# @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="body")
primary_mobile: Optional[str] = None
"""
The primary mobile for the contact.
"""
# @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="body")
primary_email: Optional[str] = None
"""
The primary email for the contact.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactsStaff:
contact_id: Optional[str] = None
contact_staff_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactsModel:
# @ApiMember(DataType="string", Description="List of Contacts with details.", Name="Contacts", ParameterType="body")
contacts: Optional[IList[SubscriptionContactModel]] = None
"""
List of Contacts with details.
"""
# @ApiMember(DataType="string", Description="List of contact-staff details.", Name="ContactStaff", ParameterType="body")
contact_staff: Optional[IList[ContactsStaff]] = None
"""
List of contact-staff details.
"""
# @Api(Description="Returns a list of contacts with specified roles. There are options to include custom and also to include each contacts connected contacts")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContacts:
"""
Returns a list of contacts with specified roles. There are options to include custom and also to include each contacts connected contacts
"""
# @ApiMember(DataType="Guid", Description="Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="body")
suite_data_source_instance_id: Optional[str] = None
"""
Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.
"""
# @ApiMember(DataType="List<Guid>", Description="A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)", IsRequired=true, Name="ContactRoles", ParameterType="body")
contact_roles: List[str] = field(default_factory=list)
"""
A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)
"""
# @ApiMember(DataType="List<Guid>", Description="A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)", Name="ContactTypes", ParameterType="body")
contact_types: Optional[List[str]] = None
"""
A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)
"""
# @ApiMember(DataType="bool", Description="Set to true if you want to include the any linked staff for each contact.", IsRequired=true, Name="IncludeStaff", ParameterType="body")
include_staff: bool = False
"""
Set to true if you want to include the any linked staff for each contact.
"""
# @ApiMember(DataType="Guid", Description="To include custom content then you need to specify the view Id of the content to include.", Name="CustomContentViewId", ParameterType="body")
custom_content_view_id: Optional[str] = None
"""
To include custom content then you need to specify the view Id of the content to include.
"""
# @ApiMember(DataType="DateTime", Description="Set the date to return only contacts that have been modified since a particular date.", Name="ModifiedSince", ParameterType="body")
modified_since: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Set the date to return only contacts that have been modified since a particular date.
"""
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 /jsv/reply/GetContacts HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ContactRoles:
[
00000000-0000-0000-0000-000000000000
],
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
IncludeStaff: False,
ModifiedSince: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}