Platform API

<back to all web services

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
System.IO.InvalidDataException: MetaData is potentially malicious. Expected scalar value, Received: The altitude of an address - the altitude above sea level."
   at ServiceStack.NativeTypes.VbNet.VbNetGeneratorExtensions.SafeValue(String value)
   at ServiceStack.NativeTypes.VbNet.VbNetGeneratorExtensions.QuotedSafeValue(String value)
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.TypeValue(String type, String value)
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.AppendAttributes(StringBuilderWrapper sb, List`1 attributes)
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.AddProperties(StringBuilderWrapper sb, MetadataType type, Dictionary`2 explicitInterfacesMap, Boolean includeResponseStatus)
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.AppendType(StringBuilderWrapper& sb, MetadataType type, String lastNS, List`1 allTypes, CreateTypeOptions options)
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.GetCode(MetadataTypes metadata, IRequest request, INativeTypesMetadata nativeTypes)
   at ServiceStack.NativeTypes.LangGeneratorExtensions.g__Generate|1_0(ILangGenerator gen, <>c__DisplayClass1_0& )
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure)
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(List`1 metadataTypes, String lang, IRequest req, Action`1 configure)
   at ServiceStack.Metadata.BaseMetadataHandler.d__12.MoveNext()

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RegisterNewUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <BusinessProfile>
    <Abn>String</Abn>
    <Acn>String</Acn>
    <Arbn>String</Arbn>
    <ContactDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">
      <d3p1:ContactDetailModel>
        <d3p1:_x003C_ContactAddress_x003E_k__BackingField>
          <d3p1:_x003C_Address_x003E_k__BackingField>
            <d3p1:_addressFull>String</d3p1:_addressFull>
            <d3p1:_x003C_AddressFormatId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_AddressFormatId_x003E_k__BackingField>
            <d3p1:_x003C_AddressLineOne_x003E_k__BackingField>String</d3p1:_x003C_AddressLineOne_x003E_k__BackingField>
            <d3p1:_x003C_AddressLineTwo_x003E_k__BackingField>String</d3p1:_x003C_AddressLineTwo_x003E_k__BackingField>
            <d3p1:_x003C_AutoMapCoordinates_x003E_k__BackingField>false</d3p1:_x003C_AutoMapCoordinates_x003E_k__BackingField>
            <d3p1:_x003C_BuildingNumber_x003E_k__BackingField>String</d3p1:_x003C_BuildingNumber_x003E_k__BackingField>
            <d3p1:_x003C_CountryId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_CountryId_x003E_k__BackingField>
            <d3p1:_x003C_CountryName_x003E_k__BackingField>String</d3p1:_x003C_CountryName_x003E_k__BackingField>
            <d3p1:_x003C_DistanceAway_x003E_k__BackingField>0</d3p1:_x003C_DistanceAway_x003E_k__BackingField>
            <d3p1:_x003C_ISOCountryCode_x003E_k__BackingField>String</d3p1:_x003C_ISOCountryCode_x003E_k__BackingField>
            <d3p1:_x003C_IsPhysical_x003E_k__BackingField>false</d3p1:_x003C_IsPhysical_x003E_k__BackingField>
            <d3p1:_x003C_Latitude_x003E_k__BackingField>0</d3p1:_x003C_Latitude_x003E_k__BackingField>
            <d3p1:_x003C_LocationCoordinates_x003E_k__BackingField>
              <d3p1:_x003C_Accuracy_x003E_k__BackingField>0</d3p1:_x003C_Accuracy_x003E_k__BackingField>
              <d3p1:_x003C_AltitudeAccuracy_x003E_k__BackingField>0</d3p1:_x003C_AltitudeAccuracy_x003E_k__BackingField>
              <d3p1:_x003C_Altitude_x003E_k__BackingField>0</d3p1:_x003C_Altitude_x003E_k__BackingField>
              <d3p1:_x003C_Heading_x003E_k__BackingField>0</d3p1:_x003C_Heading_x003E_k__BackingField>
              <d3p1:_x003C_Latitude_x003E_k__BackingField>0</d3p1:_x003C_Latitude_x003E_k__BackingField>
              <d3p1:_x003C_Longitude_x003E_k__BackingField>0</d3p1:_x003C_Longitude_x003E_k__BackingField>
              <d3p1:_x003C_Speed_x003E_k__BackingField>0</d3p1:_x003C_Speed_x003E_k__BackingField>
              <d3p1:_x003C_VerticalSpeed_x003E_k__BackingField>0</d3p1:_x003C_VerticalSpeed_x003E_k__BackingField>
            </d3p1:_x003C_LocationCoordinates_x003E_k__BackingField>
            <d3p1:_x003C_Longitude_x003E_k__BackingField>0</d3p1:_x003C_Longitude_x003E_k__BackingField>
            <d3p1:_x003C_LotNumber_x003E_k__BackingField>String</d3p1:_x003C_LotNumber_x003E_k__BackingField>
            <d3p1:_x003C_Notes_x003E_k__BackingField>String</d3p1:_x003C_Notes_x003E_k__BackingField>
            <d3p1:_x003C_PostCode_x003E_k__BackingField>String</d3p1:_x003C_PostCode_x003E_k__BackingField>
            <d3p1:_x003C_StateShortName_x003E_k__BackingField>String</d3p1:_x003C_StateShortName_x003E_k__BackingField>
            <d3p1:_x003C_StreetName_x003E_k__BackingField>String</d3p1:_x003C_StreetName_x003E_k__BackingField>
            <d3p1:_x003C_StreetNumber_x003E_k__BackingField>String</d3p1:_x003C_StreetNumber_x003E_k__BackingField>
            <d3p1:_x003C_SubUnit_x003E_k__BackingField>String</d3p1:_x003C_SubUnit_x003E_k__BackingField>
            <d3p1:_x003C_SuburbId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_SuburbId_x003E_k__BackingField>
            <d3p1:_x003C_SuburbName_x003E_k__BackingField>String</d3p1:_x003C_SuburbName_x003E_k__BackingField>
          </d3p1:_x003C_Address_x003E_k__BackingField>
          <d3p1:_x003C_CountryName_x003E_k__BackingField>String</d3p1:_x003C_CountryName_x003E_k__BackingField>
          <d3p1:_x003C_IsPostal_x003E_k__BackingField>false</d3p1:_x003C_IsPostal_x003E_k__BackingField>
          <d3p1:_x003C_IsPrimaryLocation_x003E_k__BackingField>false</d3p1:_x003C_IsPrimaryLocation_x003E_k__BackingField>
          <d3p1:_x003C_IsRegisteredLocation_x003E_k__BackingField>false</d3p1:_x003C_IsRegisteredLocation_x003E_k__BackingField>
          <d3p1:_x003C_StateName_x003E_k__BackingField>String</d3p1:_x003C_StateName_x003E_k__BackingField>
          <d3p1:_x003C_SuburbName_x003E_k__BackingField>String</d3p1:_x003C_SuburbName_x003E_k__BackingField>
        </d3p1:_x003C_ContactAddress_x003E_k__BackingField>
        <d3p1:_x003C_ContactDetailsCode_x003E_k__BackingField>String</d3p1:_x003C_ContactDetailsCode_x003E_k__BackingField>
        <d3p1:_x003C_ContactDetails_x003E_k__BackingField>String</d3p1:_x003C_ContactDetails_x003E_k__BackingField>
        <d3p1:_x003C_ContactMethodId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_ContactMethodId_x003E_k__BackingField>
        <d3p1:_x003C_ContactMethodName_x003E_k__BackingField>String</d3p1:_x003C_ContactMethodName_x003E_k__BackingField>
        <d3p1:_x003C_ContactPhone_x003E_k__BackingField>
          <d3p1:_x003C_AreaCode_x003E_k__BackingField>String</d3p1:_x003C_AreaCode_x003E_k__BackingField>
          <d3p1:_x003C_CountryCode_x003E_k__BackingField>String</d3p1:_x003C_CountryCode_x003E_k__BackingField>
          <d3p1:_x003C_LocalNumber_x003E_k__BackingField>String</d3p1:_x003C_LocalNumber_x003E_k__BackingField>
        </d3p1:_x003C_ContactPhone_x003E_k__BackingField>
        <d3p1:_x003C_CountryId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d3p1:_x003C_CountryId_x003E_k__BackingField>
        <d3p1:_x003C_IsPrimaryContactMethod_x003E_k__BackingField>false</d3p1:_x003C_IsPrimaryContactMethod_x003E_k__BackingField>
        <d3p1:_x003C_Notes_x003E_k__BackingField>String</d3p1:_x003C_Notes_x003E_k__BackingField>
        <d3p1:_x003C_OrderContactMethod_x003E_k__BackingField>0</d3p1:_x003C_OrderContactMethod_x003E_k__BackingField>
      </d3p1:ContactDetailModel>
    </ContactDetails>
    <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
    <ContactType>00000000-0000-0000-0000-000000000000</ContactType>
    <Description>String</Description>
    <EmploymentGeographicArea>String</EmploymentGeographicArea>
    <EmploymentIndustry>String</EmploymentIndustry>
    <EmploymentRole>String</EmploymentRole>
    <FirstName>String</FirstName>
    <GenderId>00000000-0000-0000-0000-000000000000</GenderId>
    <GstRegistered>false</GstRegistered>
    <LegalName>String</LegalName>
    <ProfileName>String</ProfileName>
    <Surname>String</Surname>
    <Timezone>00000000-0000-0000-0000-000000000000</Timezone>
    <Title>String</Title>
    <TradingName>String</TradingName>
    <UserId>00000000-0000-0000-0000-000000000000</UserId>
    <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
  </BusinessProfile>
  <Description>String</Description>
  <EmailAddress>String</EmailAddress>
  <EmploymentGeographicArea>String</EmploymentGeographicArea>
  <EmploymentIndustry>String</EmploymentIndustry>
  <EmploymentRole>String</EmploymentRole>
  <FirstName>String</FirstName>
  <Password>String</Password>
  <Surname>String</Surname>
  <Timezone>00000000-0000-0000-0000-000000000000</Timezone>
</RegisterNewUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>