| All Verbs | /api/profile/business |
|---|
"use strict";
export class AddBusinessProfileResponse {
/** @param {{Message?:string,ErrorCode?:string,Errors?:ResponseError[],UserProfileId?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Short description of the overall status of the web service response. */
Message;
/**
* @type {string}
* @description Holds a code representing the exception type. */
ErrorCode;
/**
* @type {ResponseError[]}
* @description Details of 1 or more validation errors from the web service */
Errors;
/**
* @type {string}
* @description Guid representing the object that is the Businesses User Profile Id in Eros. */
UserProfileId;
/**
* @type {ResponseStatus}
* @description Service Stack Response Status. */
ResponseStatus;
}
export class LocationCoordinatesModel {
/** @param {{Latitude?:number,Longitude?:number,Altitude?:number,Accuracy?:number,AltitudeAccuracy?:number,Heading?:number,Speed?:number,VerticalSpeed?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface. */
Latitude;
/**
* @type {number}
* @description The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface. */
Longitude;
/**
* @type {?number}
* @description The altitude of an address - the altitude above sea level." */
Altitude;
/**
* @type {?number}
* @description Accuracy of the latitude and longitude. */
Accuracy;
/**
* @type {?number}
* @description Accurancy of the Altitude. */
AltitudeAccuracy;
/**
* @type {?number}
* @description Direction you are heading. */
Heading;
/**
* @type {?number}
* @description Speed you are going. */
Speed;
/**
* @type {?number}
* @description Speed your altitude is ascending/descending at. */
VerticalSpeed;
}
export class AddressModel {
/** @param {{DistanceAway?:number,Latitude?:number,Longitude?:number,AddressFormatId?:string,SuburbId?:string,SuburbName?:string,StateShortName?:string,PostCode?:string,CountryId?:string,CountryName?:string,ISOCountryCode?:string,LotNumber?:string,SubUnit?:string,BuildingNumber?:string,StreetNumber?:string,StreetName?:string,AddressLineOne?:string,AddressLineTwo?:string,AddressFull?:string,IsPhysical?:boolean,Notes?:string,AutoMapCoordinates?:boolean,LocationCoordinates?:LocationCoordinatesModel}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The distance between this project and another specified set of gps coordinates. */
DistanceAway;
/**
* @type {number}
* @description The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface. */
Latitude;
/**
* @type {number}
* @description The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface. */
Longitude;
/**
* @type {string}
* @description Address Format Id Guid - this will be determined by the service. */
AddressFormatId;
/**
* @type {string}
* @description Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered. */
SuburbId;
/**
* @type {string}
* @description The suburb name. */
SuburbName;
/**
* @type {string}
* @description The shortened State Name e.g Vic for Victoria. */
StateShortName;
/**
* @type {string}
* @description The suburb postcode. */
PostCode;
/**
* @type {string}
* @description Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered. */
CountryId;
/**
* @type {string}
* @description the name of the country the address is within. */
CountryName;
/**
* @type {string}
* @description ISO Country Code. */
ISOCountryCode;
/**
* @type {string}
* @description The address Lot number. */
LotNumber;
/**
* @type {string}
* @description The address Sub Unit number. */
SubUnit;
/**
* @type {string}
* @description The address building number. */
BuildingNumber;
/**
* @type {string}
* @description The address street number. */
StreetNumber;
/**
* @type {string}
* @description The address street name including street type. */
StreetName;
/**
* @type {string}
* @description A formatted address Line 1. */
AddressLineOne;
/**
* @type {string}
* @description A formatted address Line 2. */
AddressLineTwo;
/**
* @type {string}
* @description The full address string. */
AddressFull;
/**
* @type {?boolean}
* @description True if the address is a physical location. */
IsPhysical;
/**
* @type {string}
* @description Notes about the address. */
Notes;
/**
* @type {?boolean}
* @description If true, the address is eligible for having its coordinates calculated/updated. */
AutoMapCoordinates;
/**
* @type {LocationCoordinatesModel}
* @description Location Coordinates for the address. */
LocationCoordinates;
}
export class ContactAddressModel {
/** @param {{Address?:AddressModel,IsPostal?:boolean,IsPrimaryLocation?:boolean,IsRegisteredLocation?:boolean,SuburbName?:string,StateName?:string,CountryName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {AddressModel}
* @description Address Details */
Address;
/**
* @type {boolean}
* @description True if this is a postal address. */
IsPostal;
/**
* @type {boolean}
* @description True if this is the primary address. */
IsPrimaryLocation;
/**
* @type {boolean}
* @description True if this address is the registered tax address. */
IsRegisteredLocation;
/**
* @type {string}
* @description Suburb Name */
SuburbName;
/**
* @type {string}
* @description State Name */
StateName;
/**
* @type {string}
* @description Country Name */
CountryName;
}
export class PhoneModel {
/** @param {{CountryCode?:string,AreaCode?:string,LocalNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Country Code */
CountryCode;
/**
* @type {string}
* @description Area Code */
AreaCode;
/**
* @type {string}
* @description Local Number */
LocalNumber;
}
export class ContactDetailModel {
/** @param {{ContactMethodId?:string,ContactMethodName?:string,ContactAddress?:ContactAddressModel,ContactPhone?:PhoneModel,CountryId?:string,ContactDetails?:string,Notes?:string,ContactDetailsCode?:string,OrderContactMethod?:number,IsPrimaryContactMethod?:boolean,IsAddress?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Id of the Contact Method */
ContactMethodId;
/**
* @type {string}
* @description Contact Method Name */
ContactMethodName;
/**
* @type {ContactAddressModel}
* @description If the contact method is an address, this will contain the address details. */
ContactAddress;
/**
* @type {PhoneModel}
* @description If the contact method is a phone, this will contain the phone details */
ContactPhone;
/**
* @type {?string}
* @description Id of the country */
CountryId;
/**
* @type {string}
* @description A summary string representing the contact details */
ContactDetails;
/**
* @type {string}
* @description Notes about the contact details */
Notes;
/**
* @type {string}
* @description Area Code if contact details are a phone number */
ContactDetailsCode;
/**
* @type {number}
* @description Order number of the contact method */
OrderContactMethod;
/**
* @type {boolean}
* @description True if this is the primary contact method */
IsPrimaryContactMethod;
/**
* @type {boolean}
* @description True if this contact method is an address */
IsAddress;
}
export class SaveUserProfile {
/** @param {{UserProfileId?:string,UserId?:string,ContactId?:string,ProfileName?:string,Title?:string,FirstName?:string,Surname?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,Timezone?:string,ContactDetails?:ContactDetailModel[],ContactType?:string,LegalName?:string,TradingName?:string,Abn?:string,Acn?:string,Arbn?:string,GstRegistered?:boolean,GenderId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The users profile Guid. */
UserProfileId;
/**
* @type {string}
* @description The users Guid. This is used for validation to ensure the user in the session is only changing his own user information. */
UserId;
/**
* @type {string}
* @description The users contact Guid. */
ContactId;
/**
* @type {string}
* @description The users profile name. */
ProfileName;
/**
* @type {string}
* @description The users (contact) title. */
Title;
/**
* @type {string}
* @description The users (contact) first name(s). */
FirstName;
/**
* @type {string}
* @description The users (contact) surname. */
Surname;
/**
* @type {string}
* @description The contact profile description. */
Description;
/**
* @type {string}
* @description The contacts profession/trade/industry details. */
EmploymentIndustry;
/**
* @type {string}
* @description The contact details of who they work/subcontract for. */
EmploymentRole;
/**
* @type {string}
* @description The contacts work area/suburbs. */
EmploymentGeographicArea;
/**
* @type {string}
* @description The contacts timezone. */
Timezone;
/**
* @type {ContactDetailModel[]}
* @description A list of the contact details for the contact. Note: an email must always be set for a business. */
ContactDetails = [];
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactType;
/**
* @type {string}
* @description Legal name of contact linked to the profile */
LegalName;
/**
* @type {string}
* @description Trading name of contact linked to the profile */
TradingName;
/**
* @type {string}
* @description Abn of contact linked to the profile */
Abn;
/**
* @type {string}
* @description Acn of contact linked to the profile */
Acn;
/**
* @type {string}
* @description Arbn of contact linked to the profile */
Arbn;
/**
* @type {boolean}
* @description Indicates if the Contact is registered for GST. */
GstRegistered;
/**
* @type {?string}
* @description The Gender Guid of the contact. */
GenderId;
}
export class AddBusinessProfile {
/** @param {{BusinessProfile?:SaveUserProfile}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {SaveUserProfile}
* @description The users business profile information to link to their user ID. */
BusinessProfile;
}
JavaScript AddBusinessProfile DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/profile/business HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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
{
Message: String,
ErrorCode: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}