Platform API

RegisterNewUser

Registers a new user with the platform as a 'Perspective Platform - Platform Member'

The following routes are available for this service:
All Verbs	/api/register

**RegisterNewUser** Parameters:
Name	Parameter	Data Type	Required	Description
EmailAddress	query	string	Yes	Details of the contacts primary/default user profile.
Password	query	string	Yes	Details of the contacts primary/default user profile.
FirstName	query	string	Yes	Details of the contacts primary/default user profile.
Surname	query	string	Yes	The users surname.
Description	query	string	Yes	The users public profile description.
EmploymentIndustry	query	string	Yes	The users industry they work in and what they do (Profession/Trade/Industry).
EmploymentRole	query	string	Yes	The users company/trading name and any major businesses they contract to (Working/Subcontracting for).
EmploymentGeographicArea	query	string	Yes	The users areas or geographic regions they work in (Work Areas/Suburbs).
Timezone	query	Guid	No	The users timezone.
BusinessProfile	query	SaveUserProfile	No	The users business profile information (if they have a business).

**SaveUserProfile** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	query	Guid	Yes	The users profile Guid.
UserId	query	Guid	Yes	The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.
ContactId	query	Guid	Yes	The users contact Guid.
ProfileName	query	string	Yes	The users profile name.
Title	query	string	No	The users (contact) title.
FirstName	query	string	Yes	The users (contact) first name(s).
Surname	query	string	Yes	The users (contact) surname.
Description	query	string	No	The contact profile description.
EmploymentIndustry	query	string	No	The contacts profession/trade/industry details.
EmploymentRole	query	string	No	The contact details of who they work/subcontract for.
EmploymentGeographicArea	query	string	No	The contacts work area/suburbs.
Timezone	query	Guid	No	The contacts timezone.
ContactDetails	query	List<ContactDetailModel>	Yes	A list of the contact details for the contact. Note: an email must always be set for a business.
ContactType	form	string	No	Type of contact (person, organisation etc.) linked to the profile
LegalName	form	string	No	Legal name of contact linked to the profile
TradingName	form	string	No	Trading name of contact linked to the profile
Abn	form	string	No	Abn of contact linked to the profile
Acn	form	string	No	Acn of contact linked to the profile
Arbn	form	string	No	Arbn of contact linked to the profile
GstRegistered	query	bool	No	Indicates if the Contact is registered for GST.
GenderId	query	Guid	No	The Gender Guid of the contact.

**ContactDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactMethodId	body	Guid	No	Id of the Contact Method
ContactMethodName	body	string	No	Contact Method Name
ContactAddress	body	ContactAddressModel	No	If the contact method is an address, this will contain the address details.
ContactPhone	body	PhoneModel	No	If the contact method is a phone, this will contain the phone details
CountryId	body	Guid?	No	Id of the country
ContactDetails	body	string	No	A summary string representing the contact details
Notes	body	string	No	Notes about the contact details
ContactDetailsCode	body	string	No	Area Code if contact details are a phone number
OrderContactMethod	body	int	No	Order number of the contact method
IsPrimaryContactMethod	body	bool	No	True if this is the primary contact method
IsAddress	body	bool	No	True if this contact method is an address

**ContactAddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
Address	body	AddressModel	No	Address Details
IsPostal	body	bool	No	True if this is a postal address.
IsPrimaryLocation	body	bool	No	True if this is the primary address.
IsRegisteredLocation	body	bool	No	True if this address is the registered tax address.
SuburbName	body	string	No	Suburb Name
StateName	body	string	No	State Name
CountryName	body	string	No	Country Name

**AddressModel** Parameters:
Name	Parameter	Data Type	Required	Description
DistanceAway	body	double	No	The distance between this project and another specified set of gps coordinates.
Latitude	body	Double?	No	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	body	Double?	No	The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
AddressFormatId	body	Guid	No	Address Format Id Guid - this will be determined by the service.
SuburbId	body	Guid	No	Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
SuburbName	body	string	No	The suburb name.
StateShortName	body	string	No	The shortened State Name e.g Vic for Victoria.
PostCode	body	string	No	The suburb postcode.
CountryId	body	Guid	No	Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
CountryName	body	string	No	the name of the country the address is within.
ISOCountryCode	query	string	No	ISO Country Code.
LotNumber	body	string	No	The address Lot number.
SubUnit	body	string	No	The address Sub Unit number.
BuildingNumber	body	string	No	The address building number.
StreetNumber	body	string	No	The address street number.
StreetName	body	string	No	The address street name including street type.
AddressLineOne	body	string	No	A formatted address Line 1.
AddressLineTwo	body	string	No	A formatted address Line 2.
AddressFull	body	string	No	The full address string.
IsPhysical	body	bool?	No	True if the address is a physical location.
Notes	form	string	No	Notes about the address.
AutoMapCoordinates	body	bool?	No	If true, the address is eligible for having its coordinates calculated/updated.
LocationCoordinates	body	LocationCoordinates	No	Location Coordinates for the address.

**LocationCoordinatesModel** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	query	double	No	The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
Longitude	query	double	No	The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
Altitude	query	double?	No	The altitude of an address - the altitude above sea level."
Accuracy	query	double?	No	Accuracy of the latitude and longitude.
AltitudeAccuracy	query	double?	No	Accurancy of the Altitude.
Heading	query	double?	No	Direction you are heading.
Speed	query	double?	No	Speed you are going.
VerticalSpeed	query	double?	No	Speed your altitude is ascending/descending at.

**PhoneModel** Parameters:
Name	Parameter	Data Type	Required	Description
CountryCode	body	string	No	Country Code
AreaCode	body	string	No	Area Code
LocalNumber	body	string	No	Local Number

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}