| All Verbs | /api/register |
|---|
import Foundation
import ServiceStack
/**
* Registers a new user with the platform as a 'Perspective Platform - Platform Member'
*/
// @Api(Description="Registers a new user with the platform as a 'Perspective Platform - Platform Member'")
public class RegisterNewUser : Codable
{
/**
* Details of the contacts primary/default user profile.
*/
// @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="EmailAddress", ParameterType="query")
public var emailAddress:String
/**
* 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")
public var password:String
/**
* 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")
public var firstName:String
/**
* The users surname.
*/
// @ApiMember(DataType="string", Description="The users surname.", IsRequired=true, Name="Surname", ParameterType="query")
public var surname:String
/**
* The users public profile description.
*/
// @ApiMember(DataType="string", Description="The users public profile description.", IsRequired=true, Name="Description", ParameterType="query")
public var Description:String
/**
* The users industry they work in and what they do (Profession/Trade/Industry).
*/
// @ApiMember(DataType="string", Description="The users industry they work in and what they do (Profession/Trade/Industry).", IsRequired=true, Name="EmploymentIndustry", ParameterType="query")
public var employmentIndustry:String
/**
* The users company/trading name and any major businesses they contract to (Working/Subcontracting for).
*/
// @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")
public var employmentRole:String
/**
* The users areas or geographic regions they work in (Work Areas/Suburbs).
*/
// @ApiMember(DataType="string", Description="The users areas or geographic regions they work in (Work Areas/Suburbs).", IsRequired=true, Name="EmploymentGeographicArea", ParameterType="query")
public var employmentGeographicArea:String
/**
* The users timezone.
*/
// @ApiMember(DataType="Guid", Description="The users timezone.", Name="Timezone", ParameterType="query")
public var timezone:String
/**
* The users business profile information (if they have a business).
*/
// @ApiMember(DataType="SaveUserProfile", Description="The users business profile information (if they have a business).", Name="BusinessProfile", ParameterType="query")
public var businessProfile:SaveUserProfile
required public init(){}
}
/**
* Updates a Users Profile information'
*/
// @Api(Description="Updates a Users Profile information'")
public class SaveUserProfile : Codable
{
/**
* The users profile Guid.
*/
// @ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")
public var userProfileId:String
/**
* 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 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")
public var userId:String
/**
* The users contact Guid.
*/
// @ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")
public var contactId:String
/**
* The users profile name.
*/
// @ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")
public var profileName:String
/**
* The users (contact) title.
*/
// @ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")
public var title:String
/**
* The users (contact) first name(s).
*/
// @ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")
public var firstName:String
/**
* The users (contact) surname.
*/
// @ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")
public var surname:String
/**
* The contact profile description.
*/
// @ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")
public var Description:String
/**
* The contacts profession/trade/industry details.
*/
// @ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")
public var employmentIndustry:String
/**
* The contact details of who they work/subcontract for.
*/
// @ApiMember(DataType="string", Description="The contact details of who they work/subcontract for.", Name="EmploymentRole", ParameterType="query")
public var employmentRole:String
/**
* The contacts work area/suburbs.
*/
// @ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")
public var employmentGeographicArea:String
/**
* The contacts timezone.
*/
// @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
public var timezone:String
/**
* A list of the contact details for the contact. Note: an email must always be set for a business.
*/
// @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")
public var contactDetails:[ContactDetailModel] = []
/**
* 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="ContactType")
public var contactType:String
/**
* Legal name of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
public var legalName:String
/**
* Trading name of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
public var tradingName:String
/**
* Abn of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Abn of contact linked to the profile", Name="Abn")
public var abn:String
/**
* Acn of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Acn of contact linked to the profile", Name="Acn")
public var acn:String
/**
* Arbn of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Arbn of contact linked to the profile", Name="Arbn")
public var arbn:String
/**
* Indicates if the Contact is registered for GST.
*/
// @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
public var gstRegistered:Bool
/**
* The Gender Guid of the contact.
*/
// @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
public var genderId:String?
required public init(){}
}
public class ContactDetailModel : Codable
{
/**
* Id of the Contact Method
*/
// @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
public var contactMethodId:String
/**
* Contact Method Name
*/
// @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
public var contactMethodName:String
/**
* If the contact method is an address, this will contain the address details.
*/
// @ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
public var contactAddress:ContactAddressModel
/**
* If the contact method is a phone, this will contain the phone details
*/
// @ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
public var contactPhone:PhoneModel
/**
* Id of the country
*/
// @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
public var countryId:String?
/**
* A summary string representing the contact details
*/
// @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
public var contactDetails:String
/**
* Notes about the contact details
*/
// @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
public var notes:String
/**
* Area Code if contact details are a phone number
*/
// @ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
public var contactDetailsCode:String
/**
* Order number of the contact method
*/
// @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
public var orderContactMethod:Int
/**
* True if this is the primary contact method
*/
// @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
public var isPrimaryContactMethod:Bool
/**
* True if this contact method is an address
*/
// @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
public var isAddress:Bool
required public init(){}
}
public class ContactAddressModel : Codable
{
/**
* Address Details
*/
// @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
public var address:AddressModel
/**
* True if this is a postal address.
*/
// @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
public var isPostal:Bool
/**
* True if this is the primary address.
*/
// @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
public var isPrimaryLocation:Bool
/**
* True if this address is the registered tax address.
*/
// @ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")
public var isRegisteredLocation:Bool
/**
* Suburb Name
*/
// @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
public var suburbName:String
/**
* State Name
*/
// @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
public var stateName:String
/**
* Country Name
*/
// @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
public var countryName:String
required public init(){}
}
public class AddressModel : Codable
{
/**
* The distance between this project and another specified set of gps coordinates.
*/
// @ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="body")
public var distanceAway:Double
/**
* 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 latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", Name="Latitude", ParameterType="body")
public var latitude:Double
/**
* The longitude of an address - geographic coordinates specifying the east-west 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")
public var longitude:Double
/**
* Address Format Id Guid - this will be determined by the service.
*/
// @ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="body")
public var addressFormatId:String
/**
* Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
*/
// @ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="body")
public var suburbId:String
/**
* The suburb name.
*/
// @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
public var suburbName:String
/**
* The shortened State Name e.g Vic for Victoria.
*/
// @ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")
public var stateShortName:String
/**
* The suburb postcode.
*/
// @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
public var postCode:String
/**
* Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
*/
// @ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="body")
public var countryId:String
/**
* the name of the country the address is within.
*/
// @ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="body")
public var countryName:String
/**
* ISO Country Code.
*/
// @ApiMember(Description="ISO Country Code.", ParameterType="query")
public var isoCountryCode:String
/**
* The address Lot number.
*/
// @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
public var lotNumber:String
/**
* The address Sub Unit number.
*/
// @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
public var subUnit:String
/**
* The address building number.
*/
// @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
public var buildingNumber:String
/**
* The address street number.
*/
// @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
public var streetNumber:String
/**
* The address street name including street type.
*/
// @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")
public var streetName:String
/**
* A formatted address Line 1.
*/
// @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
public var addressLineOne:String
/**
* A formatted address Line 2.
*/
// @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
public var addressLineTwo:String
/**
* The full address string.
*/
// @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
public var addressFull:String
/**
* True if the address is a physical location.
*/
// @ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="body")
public var isPhysical:Bool?
/**
* Notes about the address.
*/
// @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
public var notes:String
/**
* If true, the address is eligible for having its coordinates calculated/updated.
*/
// @ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="body")
public var autoMapCoordinates:Bool?
/**
* Location Coordinates for the address.
*/
// @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
public var locationCoordinates:LocationCoordinatesModel
required public init(){}
}
public class LocationCoordinatesModel : Codable
{
/**
* The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
*/
// @ApiMember(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", ParameterType="query")
public var latitude:Double
/**
* The longitude of an address - geographic coordinates specifying the east-west 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")
public var longitude:Double
/**
* The altitude of an address - the altitude above sea level."
*/
// @ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")
public var altitude:Double?
/**
* Accuracy of the latitude and longitude.
*/
// @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
public var accuracy:Double?
/**
* Accurancy of the Altitude.
*/
// @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
public var altitudeAccuracy:Double?
/**
* Direction you are heading.
*/
// @ApiMember(Description="Direction you are heading.", ParameterType="query")
public var heading:Double?
/**
* Speed you are going.
*/
// @ApiMember(Description="Speed you are going.", ParameterType="query")
public var speed:Double?
/**
* Speed your altitude is ascending/descending at.
*/
// @ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")
public var verticalSpeed:Double?
required public init(){}
}
public class PhoneModel : Codable
{
/**
* Country Code
*/
// @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
public var countryCode:String
/**
* Area Code
*/
// @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
public var areaCode:String
/**
* Local Number
*/
// @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
public var localNumber:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"EmailAddress":"String","Password":"String","FirstName":"String","Surname":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","Timezone":"00000000-0000-0000-0000-000000000000","BusinessProfile":{"UserProfileId":"00000000-0000-0000-0000-000000000000","UserId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","ProfileName":"String","Title":"String","FirstName":"String","Surname":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","Timezone":"00000000-0000-0000-0000-000000000000","ContactDetails":[{"ContactMethodId":"00000000-0000-0000-0000-000000000000","ContactMethodName":"String","ContactAddress":{"Address":{"DistanceAway":0,"Latitude":0,"Longitude":0,"AddressFormatId":"00000000-0000-0000-0000-000000000000","SuburbId":"00000000-0000-0000-0000-000000000000","SuburbName":"String","StateShortName":"String","PostCode":"String","CountryId":"00000000-0000-0000-0000-000000000000","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}],"ContactType":"00000000-0000-0000-0000-000000000000","LegalName":"String","TradingName":"String","Abn":"String","Acn":"String","Arbn":"String","GstRegistered":false,"GenderId":"00000000000000000000000000000000"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}