Platform API

<back to all web services

AddBusinessProfile

Updates a Users Profile information'

export class AddBusinessProfileResponse
{
    /** @description Short description of the overall status of the web service response. */
    // @ApiMember(DataType="string", Description="Short description of the overall status of the web service response.", Name="Message", ParameterType="query")
    public Message: string;

    /** @description Holds a code representing the exception type. */
    // @ApiMember(DataType="string", Description="Holds a code representing the exception type.", Name="ErrorCode", ParameterType="query")
    public ErrorCode: string;

    /** @description Details of 1 or more validation errors from the web service */
    // @ApiMember(DataType="List<ResponseError>", Description="Details of 1 or more validation errors from the web service", Name="Errors", ParameterType="query")
    public Errors: ResponseError[];

    /** @description Guid representing the object that is the Businesses User Profile Id in Eros. */
    // @ApiMember(DataType="Guid", Description="Guid representing the object that is the Businesses User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")
    public UserProfileId: string;

    /** @description Service Stack Response Status. */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<AddBusinessProfileResponse>) { (Object as any).assign(this, init); }
}

export class LocationCoordinatesModel
{
    /** @description 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 Latitude: number;

    /** @description 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 Longitude: number;

    /** @description 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 Altitude?: number;

    /** @description Accuracy of the latitude and longitude. */
    // @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
    public Accuracy?: number;

    /** @description Accurancy of the Altitude. */
    // @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
    public AltitudeAccuracy?: number;

    /** @description Direction you are heading. */
    // @ApiMember(Description="Direction you are heading.", ParameterType="query")
    public Heading?: number;

    /** @description Speed you are going. */
    // @ApiMember(Description="Speed you are going.", ParameterType="query")
    public Speed?: number;

    /** @description Speed your altitude is ascending/descending at. */
    // @ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")
    public VerticalSpeed?: number;

    public constructor(init?: Partial<LocationCoordinatesModel>) { (Object as any).assign(this, init); }
}

export class AddressModel
{
    /** @description 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 DistanceAway: number;

    /** @description 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 Latitude: number;

    /** @description 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 Longitude: number;

    /** @description 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 AddressFormatId: string;

    /** @description 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 SuburbId: string;

    /** @description The suburb name. */
    // @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
    public SuburbName: string;

    /** @description 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 StateShortName: string;

    /** @description The suburb postcode. */
    // @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
    public PostCode: string;

    /** @description 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 CountryId: string;

    /** @description 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 CountryName: string;

    /** @description ISO Country Code. */
    // @ApiMember(Description="ISO Country Code.", ParameterType="query")
    public ISOCountryCode: string;

    /** @description The address Lot number. */
    // @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
    public LotNumber: string;

    /** @description The address Sub Unit number. */
    // @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
    public SubUnit: string;

    /** @description The address building number. */
    // @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
    public BuildingNumber: string;

    /** @description The address street number. */
    // @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
    public StreetNumber: string;

    /** @description The address street name including street type. */
    // @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")
    public StreetName: string;

    /** @description A formatted address Line 1. */
    // @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
    public AddressLineOne: string;

    /** @description A formatted address Line 2. */
    // @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
    public AddressLineTwo: string;

    /** @description The full address string. */
    // @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
    public AddressFull: string;

    /** @description 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 IsPhysical?: boolean;

    /** @description Notes about the address. */
    // @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
    public Notes: string;

    /** @description 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 AutoMapCoordinates?: boolean;

    /** @description Location Coordinates for the address. */
    // @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
    public LocationCoordinates: LocationCoordinatesModel;

    public constructor(init?: Partial<AddressModel>) { (Object as any).assign(this, init); }
}

export class ContactAddressModel
{
    /** @description Address Details */
    // @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
    public Address: AddressModel;

    /** @description True if this is a postal address. */
    // @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
    public IsPostal: boolean;

    /** @description True if this is the primary address. */
    // @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
    public IsPrimaryLocation: boolean;

    /** @description 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 IsRegisteredLocation: boolean;

    /** @description Suburb Name */
    // @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
    public SuburbName: string;

    /** @description State Name */
    // @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
    public StateName: string;

    /** @description Country Name */
    // @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
    public CountryName: string;

    public constructor(init?: Partial<ContactAddressModel>) { (Object as any).assign(this, init); }
}

export class PhoneModel
{
    /** @description Country Code */
    // @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
    public CountryCode: string;

    /** @description Area Code */
    // @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
    public AreaCode: string;

    /** @description Local Number */
    // @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
    public LocalNumber: string;

    public constructor(init?: Partial<PhoneModel>) { (Object as any).assign(this, init); }
}

export class ContactDetailModel
{
    /** @description Id of the Contact Method */
    // @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
    public ContactMethodId: string;

    /** @description Contact Method Name */
    // @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
    public ContactMethodName: string;

    /** @description 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 ContactAddress: ContactAddressModel;

    /** @description 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 ContactPhone: PhoneModel;

    /** @description Id of the country */
    // @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
    public CountryId?: string;

    /** @description A summary string representing the contact details */
    // @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
    public ContactDetails: string;

    /** @description Notes about the contact details */
    // @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
    public Notes: string;

    /** @description 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 ContactDetailsCode: string;

    /** @description Order number of the contact method */
    // @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
    public OrderContactMethod: number;

    /** @description 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 IsPrimaryContactMethod: boolean;

    /** @description 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 IsAddress: boolean;

    public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}

/** @description Updates a Users Profile information' */
// @Api(Description="Updates a Users Profile information'")
export class SaveUserProfile
{
    /** @description The users profile Guid. */
    // @ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")
    public UserProfileId: string;

    /** @description 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 UserId: string;

    /** @description The users contact Guid. */
    // @ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")
    public ContactId: string;

    /** @description The users profile name. */
    // @ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")
    public ProfileName: string;

    /** @description The users (contact) title. */
    // @ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")
    public Title: string;

    /** @description The users (contact) first name(s). */
    // @ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")
    public FirstName: string;

    /** @description The users (contact) surname. */
    // @ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")
    public Surname: string;

    /** @description The contact profile description. */
    // @ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")
    public Description: string;

    /** @description The contacts profession/trade/industry details. */
    // @ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")
    public EmploymentIndustry: string;

    /** @description 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 EmploymentRole: string;

    /** @description The contacts work area/suburbs. */
    // @ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")
    public EmploymentGeographicArea: string;

    /** @description The contacts timezone. */
    // @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    public Timezone: string;

    /** @description 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 ContactDetails: ContactDetailModel[] = [];

    /** @description 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 ContactType: string;

    /** @description Legal name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    public LegalName: string;

    /** @description Trading name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    public TradingName: string;

    /** @description Abn of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Abn of contact linked to the profile", Name="Abn")
    public Abn: string;

    /** @description Acn of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Acn of contact linked to the profile", Name="Acn")
    public Acn: string;

    /** @description Arbn of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Arbn of contact linked to the profile", Name="Arbn")
    public Arbn: string;

    /** @description 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 GstRegistered: boolean;

    /** @description The Gender Guid of the contact. */
    // @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
    public GenderId?: string;

    public constructor(init?: Partial<SaveUserProfile>) { (Object as any).assign(this, init); }
}

/** @description Updates a Users Profile information' */
// @Api(Description="Updates a Users Profile information'")
export class AddBusinessProfile
{
    /** @description The users business profile information to link to their user ID. */
    // @ApiMember(DataType="SaveUserProfile", Description="The users business profile information to link to their user ID.", Name="BusinessProfile", ParameterType="query")
    public BusinessProfile: SaveUserProfile;

    public constructor(init?: Partial<AddBusinessProfile>) { (Object as any).assign(this, init); }
}

TypeScript AddBusinessProfile DTOs

POST /api/profile/business HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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

{"Message":"String","ErrorCode":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"UserProfileId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}