| All Verbs | /api/register |
|---|
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 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
"""
# @Api(Description="Updates a Users Profile information'")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveUserProfile:
"""
Updates a Users Profile information'
"""
# @ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")
user_profile_id: Optional[str] = None
"""
The users profile Guid.
"""
# @ApiMember(DataType="Guid", Description="The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.", IsRequired=true, Name="UserId", ParameterType="query")
user_id: Optional[str] = None
"""
The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.
"""
# @ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")
contact_id: Optional[str] = None
"""
The users contact Guid.
"""
# @ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")
profile_name: Optional[str] = None
"""
The users profile name.
"""
# @ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")
title: Optional[str] = None
"""
The users (contact) title.
"""
# @ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")
first_name: Optional[str] = None
"""
The users (contact) first name(s).
"""
# @ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")
surname: Optional[str] = None
"""
The users (contact) surname.
"""
# @ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")
description: Optional[str] = None
"""
The contact profile description.
"""
# @ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")
employment_industry: Optional[str] = None
"""
The contacts profession/trade/industry details.
"""
# @ApiMember(DataType="string", Description="The contact details of who they work/subcontract for.", Name="EmploymentRole", ParameterType="query")
employment_role: Optional[str] = None
"""
The contact details of who they work/subcontract for.
"""
# @ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")
employment_geographic_area: Optional[str] = None
"""
The contacts work area/suburbs.
"""
# @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
timezone: Optional[str] = None
"""
The contacts timezone.
"""
# @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact. Note: an email must always be set for a business.", IsRequired=true, Name="ContactDetails", ParameterType="query")
contact_details: List[ContactDetailModel] = field(default_factory=list)
"""
A list of the contact details for the contact. Note: an email must always be set for a business.
"""
# @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactType")
contact_type: Optional[str] = None
"""
Type of contact (person, organisation etc.) 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="Abn of contact linked to the profile", Name="Abn")
abn: Optional[str] = None
"""
Abn of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Acn of contact linked to the profile", Name="Acn")
acn: Optional[str] = None
"""
Acn of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Arbn of contact linked to the profile", Name="Arbn")
arbn: Optional[str] = None
"""
Arbn of contact linked to the profile
"""
# @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="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
gender_id: Optional[str] = None
"""
The Gender Guid of the contact.
"""
# @Api(Description="Registers a new user with the platform as a 'Perspective Platform - Platform Member'")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegisterNewUser:
"""
Registers a new user with the platform as a 'Perspective Platform - Platform Member'
"""
# @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="EmailAddress", ParameterType="query")
email_address: Optional[str] = None
"""
Details of the contacts primary/default user profile.
"""
# @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="Password", ParameterType="query")
password: Optional[str] = None
"""
Details of the contacts primary/default user profile.
"""
# @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="FirstName", ParameterType="query")
first_name: Optional[str] = None
"""
Details of the contacts primary/default user profile.
"""
# @ApiMember(DataType="string", Description="The users surname.", IsRequired=true, Name="Surname", ParameterType="query")
surname: Optional[str] = None
"""
The users surname.
"""
# @ApiMember(DataType="string", Description="The users public profile description.", IsRequired=true, Name="Description", ParameterType="query")
description: Optional[str] = None
"""
The users public profile description.
"""
# @ApiMember(DataType="string", Description="The users industry they work in and what they do (Profession/Trade/Industry).", IsRequired=true, Name="EmploymentIndustry", ParameterType="query")
employment_industry: Optional[str] = None
"""
The users industry they work in and what they do (Profession/Trade/Industry).
"""
# @ApiMember(DataType="string", Description="The users company/trading name and any major businesses they contract to (Working/Subcontracting for).", IsRequired=true, Name="EmploymentRole", ParameterType="query")
employment_role: Optional[str] = None
"""
The users company/trading name and any major businesses they contract to (Working/Subcontracting for).
"""
# @ApiMember(DataType="string", Description="The users areas or geographic regions they work in (Work Areas/Suburbs).", IsRequired=true, Name="EmploymentGeographicArea", ParameterType="query")
employment_geographic_area: Optional[str] = None
"""
The users areas or geographic regions they work in (Work Areas/Suburbs).
"""
# @ApiMember(DataType="Guid", Description="The users timezone.", Name="Timezone", ParameterType="query")
timezone: Optional[str] = None
"""
The users timezone.
"""
# @ApiMember(DataType="SaveUserProfile", Description="The users business profile information (if they have a business).", Name="BusinessProfile", ParameterType="query")
business_profile: Optional[SaveUserProfile] = None
"""
The users business profile information (if they have a business).
"""
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/register HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EmailAddress: String,
Password: String,
FirstName: String,
Surname: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
BusinessProfile:
{
ProfileName: String,
Title: String,
FirstName: String,
Surname: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
ContactDetails:
[
{
ContactMethodName: String,
ContactAddress:
{
Address:
{
DistanceAway: 0,
Latitude: 0,
Longitude: 0,
SuburbName: String,
StateShortName: String,
PostCode: String,
CountryName: String,
ISOCountryCode: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
AddressFull: String,
IsPhysical: False,
Notes: String,
AutoMapCoordinates: False,
LocationCoordinates:
{
Latitude: 0,
Longitude: 0,
Altitude: 0,
Accuracy: 0,
AltitudeAccuracy: 0,
Heading: 0,
Speed: 0,
VerticalSpeed: 0
}
},
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
}
],
LegalName: String,
TradingName: String,
Abn: String,
Acn: String,
Arbn: String,
GstRegistered: False,
GenderId: 00000000000000000000000000000000
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}