| All Verbs | /api/register |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPI.ServiceModel;
namespace Eros.Saguna.Common.WebAPI.ServiceModel
{
public partial class AddressModel
{
///<summary>
///The distance between this project and another specified set of gps coordinates.
///</summary>
[ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="body")]
public virtual double DistanceAway { get; set; }
///<summary>
///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
///</summary>
[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 virtual double Latitude { get; set; }
///<summary>
///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
///</summary>
[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 virtual double Longitude { get; set; }
///<summary>
///Address Format Id Guid - this will be determined by the service.
///</summary>
[ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="body")]
public virtual Guid AddressFormatId { get; set; }
///<summary>
///Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
///</summary>
[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 virtual Guid SuburbId { get; set; }
///<summary>
///The suburb name.
///</summary>
[ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")]
public virtual string SuburbName { get; set; }
///<summary>
///The shortened State Name e.g Vic for Victoria.
///</summary>
[ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")]
public virtual string StateShortName { get; set; }
///<summary>
///The suburb postcode.
///</summary>
[ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")]
public virtual string PostCode { get; set; }
///<summary>
///Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
///</summary>
[ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="body")]
public virtual Guid CountryId { get; set; }
///<summary>
///the name of the country the address is within.
///</summary>
[ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="body")]
public virtual string CountryName { get; set; }
///<summary>
///ISO Country Code.
///</summary>
[ApiMember(Description="ISO Country Code.", ParameterType="query")]
public virtual string ISOCountryCode { get; set; }
///<summary>
///The address Lot number.
///</summary>
[ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")]
public virtual string LotNumber { get; set; }
///<summary>
///The address Sub Unit number.
///</summary>
[ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")]
public virtual string SubUnit { get; set; }
///<summary>
///The address building number.
///</summary>
[ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")]
public virtual string BuildingNumber { get; set; }
///<summary>
///The address street number.
///</summary>
[ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")]
public virtual string StreetNumber { get; set; }
///<summary>
///The address street name including street type.
///</summary>
[ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")]
public virtual string StreetName { get; set; }
///<summary>
///A formatted address Line 1.
///</summary>
[ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")]
public virtual string AddressLineOne { get; set; }
///<summary>
///A formatted address Line 2.
///</summary>
[ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")]
public virtual string AddressLineTwo { get; set; }
///<summary>
///The full address string.
///</summary>
[ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")]
public virtual string AddressFull { get; set; }
///<summary>
///True if the address is a physical location.
///</summary>
[ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="body")]
public virtual bool? IsPhysical { get; set; }
///<summary>
///Notes about the address.
///</summary>
[ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")]
public virtual string Notes { get; set; }
///<summary>
///If true, the address is eligible for having its coordinates calculated/updated.
///</summary>
[ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="body")]
public virtual bool? AutoMapCoordinates { get; set; }
///<summary>
///Location Coordinates for the address.
///</summary>
[ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")]
public virtual LocationCoordinatesModel LocationCoordinates { get; set; }
}
public partial class ContactAddressModel
{
///<summary>
///Address Details
///</summary>
[ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")]
public virtual AddressModel Address { get; set; }
///<summary>
///True if this is a postal address.
///</summary>
[ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")]
public virtual bool IsPostal { get; set; }
///<summary>
///True if this is the primary address.
///</summary>
[ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")]
public virtual bool IsPrimaryLocation { get; set; }
///<summary>
///True if this address is the registered tax address.
///</summary>
[ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")]
public virtual bool IsRegisteredLocation { get; set; }
///<summary>
///Suburb Name
///</summary>
[ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")]
public virtual string SuburbName { get; set; }
///<summary>
///State Name
///</summary>
[ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")]
public virtual string StateName { get; set; }
///<summary>
///Country Name
///</summary>
[ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")]
public virtual string CountryName { get; set; }
}
public partial class ContactDetailModel
{
///<summary>
///Id of the Contact Method
///</summary>
[ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")]
public virtual Guid ContactMethodId { get; set; }
///<summary>
///Contact Method Name
///</summary>
[ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")]
public virtual string ContactMethodName { get; set; }
///<summary>
///If the contact method is an address, this will contain the address details.
///</summary>
[ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")]
public virtual ContactAddressModel ContactAddress { get; set; }
///<summary>
///If the contact method is a phone, this will contain the phone details
///</summary>
[ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")]
public virtual PhoneModel ContactPhone { get; set; }
///<summary>
///Id of the country
///</summary>
[ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")]
public virtual Guid? CountryId { get; set; }
///<summary>
///A summary string representing the contact details
///</summary>
[ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")]
public virtual string ContactDetails { get; set; }
///<summary>
///Notes about the contact details
///</summary>
[ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")]
public virtual string Notes { get; set; }
///<summary>
///Area Code if contact details are a phone number
///</summary>
[ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")]
public virtual string ContactDetailsCode { get; set; }
///<summary>
///Order number of the contact method
///</summary>
[ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")]
public virtual int OrderContactMethod { get; set; }
///<summary>
///True if this is the primary contact method
///</summary>
[ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")]
public virtual bool IsPrimaryContactMethod { get; set; }
///<summary>
///True if this contact method is an address
///</summary>
[ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")]
public virtual bool IsAddress { get; set; }
}
public partial class LocationCoordinatesModel
{
///<summary>
///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
///</summary>
[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 virtual double Latitude { get; set; }
///<summary>
///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
///</summary>
[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 virtual double Longitude { get; set; }
///<summary>
///The altitude of an address - the altitude above sea level."
///</summary>
[ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")]
public virtual double? Altitude { get; set; }
///<summary>
///Accuracy of the latitude and longitude.
///</summary>
[ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")]
public virtual double? Accuracy { get; set; }
///<summary>
///Accurancy of the Altitude.
///</summary>
[ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")]
public virtual double? AltitudeAccuracy { get; set; }
///<summary>
///Direction you are heading.
///</summary>
[ApiMember(Description="Direction you are heading.", ParameterType="query")]
public virtual double? Heading { get; set; }
///<summary>
///Speed you are going.
///</summary>
[ApiMember(Description="Speed you are going.", ParameterType="query")]
public virtual double? Speed { get; set; }
///<summary>
///Speed your altitude is ascending/descending at.
///</summary>
[ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")]
public virtual double? VerticalSpeed { get; set; }
}
public partial class PhoneModel
{
///<summary>
///Country Code
///</summary>
[ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")]
public virtual string CountryCode { get; set; }
///<summary>
///Area Code
///</summary>
[ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")]
public virtual string AreaCode { get; set; }
///<summary>
///Local Number
///</summary>
[ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")]
public virtual string LocalNumber { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Registers a new user with the platform as a 'Perspective Platform - Platform Member'
///</summary>
[Api(Description="Registers a new user with the platform as a 'Perspective Platform - Platform Member'")]
public partial class RegisterNewUser
{
///<summary>
///Details of the contacts primary/default user profile.
///</summary>
[ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="EmailAddress", ParameterType="query")]
public virtual string EmailAddress { get; set; }
///<summary>
///Details of the contacts primary/default user profile.
///</summary>
[ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="Password", ParameterType="query")]
public virtual string Password { get; set; }
///<summary>
///Details of the contacts primary/default user profile.
///</summary>
[ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="FirstName", ParameterType="query")]
public virtual string FirstName { get; set; }
///<summary>
///The users surname.
///</summary>
[ApiMember(DataType="string", Description="The users surname.", IsRequired=true, Name="Surname", ParameterType="query")]
public virtual string Surname { get; set; }
///<summary>
///The users public profile description.
///</summary>
[ApiMember(DataType="string", Description="The users public profile description.", IsRequired=true, Name="Description", ParameterType="query")]
public virtual string Description { get; set; }
///<summary>
///The users industry they work in and what they do (Profession/Trade/Industry).
///</summary>
[ApiMember(DataType="string", Description="The users industry they work in and what they do (Profession/Trade/Industry).", IsRequired=true, Name="EmploymentIndustry", ParameterType="query")]
public virtual string EmploymentIndustry { get; set; }
///<summary>
///The users company/trading name and any major businesses they contract to (Working/Subcontracting for).
///</summary>
[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 virtual string EmploymentRole { get; set; }
///<summary>
///The users areas or geographic regions they work in (Work Areas/Suburbs).
///</summary>
[ApiMember(DataType="string", Description="The users areas or geographic regions they work in (Work Areas/Suburbs).", IsRequired=true, Name="EmploymentGeographicArea", ParameterType="query")]
public virtual string EmploymentGeographicArea { get; set; }
///<summary>
///The users timezone.
///</summary>
[ApiMember(DataType="Guid", Description="The users timezone.", Name="Timezone", ParameterType="query")]
public virtual Guid Timezone { get; set; }
///<summary>
///The users business profile information (if they have a business).
///</summary>
[ApiMember(DataType="SaveUserProfile", Description="The users business profile information (if they have a business).", Name="BusinessProfile", ParameterType="query")]
public virtual SaveUserProfile BusinessProfile { get; set; }
}
///<summary>
///Updates a Users Profile information'
///</summary>
[Api(Description="Updates a Users Profile information'")]
public partial class SaveUserProfile
{
///<summary>
///The users profile Guid.
///</summary>
[ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")]
public virtual Guid UserProfileId { get; set; }
///<summary>
///The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.
///</summary>
[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 virtual Guid UserId { get; set; }
///<summary>
///The users contact Guid.
///</summary>
[ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")]
public virtual Guid ContactId { get; set; }
///<summary>
///The users profile name.
///</summary>
[ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")]
public virtual string ProfileName { get; set; }
///<summary>
///The users (contact) title.
///</summary>
[ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")]
public virtual string Title { get; set; }
///<summary>
///The users (contact) first name(s).
///</summary>
[ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")]
public virtual string FirstName { get; set; }
///<summary>
///The users (contact) surname.
///</summary>
[ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")]
public virtual string Surname { get; set; }
///<summary>
///The contact profile description.
///</summary>
[ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")]
public virtual string Description { get; set; }
///<summary>
///The contacts profession/trade/industry details.
///</summary>
[ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")]
public virtual string EmploymentIndustry { get; set; }
///<summary>
///The contact details of who they work/subcontract for.
///</summary>
[ApiMember(DataType="string", Description="The contact details of who they work/subcontract for.", Name="EmploymentRole", ParameterType="query")]
public virtual string EmploymentRole { get; set; }
///<summary>
///The contacts work area/suburbs.
///</summary>
[ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")]
public virtual string EmploymentGeographicArea { get; set; }
///<summary>
///The contacts timezone.
///</summary>
[ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")]
public virtual Guid Timezone { get; set; }
///<summary>
///A list of the contact details for the contact. Note: an email must always be set for a business.
///</summary>
[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 virtual List<ContactDetailModel> ContactDetails { get; set; } = [];
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactType")]
public virtual Guid ContactType { get; set; }
///<summary>
///Legal name of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")]
public virtual string LegalName { get; set; }
///<summary>
///Trading name of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")]
public virtual string TradingName { get; set; }
///<summary>
///Abn of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Abn of contact linked to the profile", Name="Abn")]
public virtual string Abn { get; set; }
///<summary>
///Acn of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Acn of contact linked to the profile", Name="Acn")]
public virtual string Acn { get; set; }
///<summary>
///Arbn of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Arbn of contact linked to the profile", Name="Arbn")]
public virtual string Arbn { get; set; }
///<summary>
///Indicates if the Contact is registered for GST.
///</summary>
[ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")]
public virtual bool GstRegistered { get; set; }
///<summary>
///The Gender Guid of the contact.
///</summary>
[ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")]
public virtual Guid? GenderId { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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: application/json
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}