| PUT | /api/profiles/{UserProfileId} | ||
|---|---|---|---|
| POST | /api/profiles |
export class UserProfileSummaryModel
{
/** @description User Profile Id */
// @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
public UserProfileId: string;
/** @description User linked to the profile */
// @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
public UserId: string;
/** @description Contact linked to the profile */
// @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
public ContactId: string;
/** @description User linked to the profile */
// @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
public UserName: string;
/** @description User Profile Name */
// @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
public ProfileName: string;
/** @description Full name of the contact linked to the profile */
// @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
public ContactFullName: string;
/** @description Email Address of the contact linked to the profile */
// @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
public EmailAddress: string;
/** @description Email signature of the contact linked to the profile */
// @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
public EmailSignature: string;
/** @description Mobile number of the contact linked to the profile */
// @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
public MobileNumber: string;
/** @description Phone number of the contact linked to the profile */
// @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
public PhoneNumber: string;
/** @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="ContactTypeId")
public ContactTypeId: string;
/** @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="ContactTypeName")
public ContactTypeName: string;
/** @description First name of the contact linked to the profile */
// @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
public FirstName: string;
/** @description Surname of the contact linked to the profile */
// @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
public Surname: string;
/** @description Title of contact linked to the profile */
// @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
public Title: 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 Australian Business Number */
// @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
public Abn: string;
/** @description Australian Company Number */
// @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
public Acn: string;
/** @description Australian Registered Body Number */
// @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
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 True if english is a secondary language for the contact. */
// @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
public ESL: boolean;
/** @description Language that is the primary language for the contact. */
// @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
public Language: string;
/** @description True if an interpreter is required. */
// @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
public InterpreterRequired: boolean;
/** @description Licensee specific notes about the contact. */
// @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
public LicenseeNotes: string;
/** @description Profile photo of contact linked to the profile */
// @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
public ProfilePhotoUrl: string;
/** @description Thumbnail photo of contact linked to the profile */
// @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
public ProfilePhotoThumbnailUrl: string;
/** @description Profile photo id of contact linked to the profile */
// @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
public ProfileImageId: string;
/** @description Profile description */
// @ApiMember(DataType="string", Description="Profile description", Name="Description")
public Description: string;
/** @description Employment Industry */
// @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
public EmploymentIndustry: string;
/** @description Employment Role */
// @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
public EmploymentRole: string;
/** @description Areas of Work */
// @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
public EmploymentGeographicArea: string;
/** @description The contacts timezone. */
// @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
public Timezone: string;
/** @description Timezone Name */
// @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
public TimezoneName: string;
/** @description The primary address of the contact */
// @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
public PrimaryAddress: string;
/** @description Is this an active contact? Or an inactive contact (deleted account)? */
// @ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
public IsActiveContact: boolean;
public constructor(init?: Partial<UserProfileSummaryModel>) { (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 GeoEstateStageModel
{
public GeoEstateStageId: string;
public GeoEstateId: string;
public Name: string;
public Notes: string;
public RecordStatus: string;
public constructor(init?: Partial<GeoEstateStageModel>) { (Object as any).assign(this, init); }
}
export class GeoEstateModel
{
public GeoEstateId: string;
public Name: string;
public Notes: string;
public DeveloperContactId: string;
public DeveloperName: string;
public DeveloperProfilePhotoUrl: string;
public DeveloperProfilePhotoThumbnail: string;
public RecordStatus: string;
public Stages: GeoEstateStageModel[];
public CurrentEstateStageId: string;
public CurrentEstateStageName: string;
public constructor(init?: Partial<GeoEstateModel>) { (Object as any).assign(this, init); }
}
export class GeoLocationModel
{
/** @description The location id */
// @ApiMember(DataType="Guid", Description="The location id", Name="GeoLocationId", ParameterType="query")
public GeoLocationId: string;
/** @description The state id */
// @ApiMember(DataType="Guid", Description="The state id", Name="StateId", ParameterType="query")
public StateId?: string;
/** @description The state name */
// @ApiMember(DataType="string", Description="The state name", Name="StateName", ParameterType="query")
public StateName: string;
/** @description The suburb id */
// @ApiMember(DataType="Guid", Description="The suburb id", Name="SuburbId", ParameterType="query")
public SuburbId?: string;
/** @description The suburb name */
// @ApiMember(DataType="string", Description="The suburb name", Name="SuburbName", ParameterType="query")
public SuburbName: string;
/** @description The country id */
// @ApiMember(DataType="Guid", Description="The country id", Name="CountryId", ParameterType="query")
public CountryId?: string;
/** @description The country name */
// @ApiMember(DataType="string", Description="The country name", Name="CountryName", ParameterType="query")
public CountryName: string;
/** @description The lot number */
// @ApiMember(DataType="string", Description="The lot number", Name="LotNumber", ParameterType="query")
public LotNumber: string;
/** @description The unit number */
// @ApiMember(DataType="string", Description="The unit number", Name="SubUnit", ParameterType="query")
public SubUnit: string;
/** @description The building number */
// @ApiMember(DataType="string", Description="The building number", Name="BuildingNumber", ParameterType="query")
public BuildingNumber: string;
/** @description PO Box Number */
// @ApiMember(DataType="string", Description="PO Box Number", Name="PostalDeliveryNumber", ParameterType="query")
public PostalDeliveryNumber: string;
/** @description The Street Number */
// @ApiMember(DataType="string", Description="The Street Number", Name="StreetNumber", ParameterType="query")
public StreetNumber: string;
/** @description The Street name */
// @ApiMember(DataType="string", Description="The Street name", Name="StreetName", ParameterType="query")
public StreetName: string;
/** @description Address Line ONe */
// @ApiMember(DataType="string", Description="Address Line ONe", Name="AddressLineOne", ParameterType="query")
public AddressLineOne: string;
/** @description Address Line Two */
// @ApiMember(DataType="string", Description="Address Line Two", Name="AddressLineTwo", ParameterType="query")
public AddressLineTwo: string;
/** @description Post code */
// @ApiMember(DataType="string", Description="Post code", Name="PostCode", ParameterType="query")
public PostCode: string;
/** @description Is location physical */
// @ApiMember(DataType="bool", Description="Is location physical", Name="IsPhysical", ParameterType="query")
public IsPhysical: boolean;
/** @description Notes about the location */
// @ApiMember(DataType="string", Description="Notes about the location", Name="Notes", ParameterType="query")
public Notes: string;
/** @description The address in full */
// @ApiMember(DataType="string", Description="The address in full", Name="AddressFull", ParameterType="query")
public AddressFull: string;
/** @description Address format id. */
// @ApiMember(DataType="Guid", Description="Address format id.", Name="AddressFormatId", ParameterType="query")
public AddressFormatId: string;
/** @description Latitude */
// @ApiMember(DataType="double", Description="Latitude", Name="Latitude", ParameterType="query")
public Latitude: number;
/** @description Longitude */
// @ApiMember(DataType="double", Description="Longitude", Name="Longitude", ParameterType="query")
public Longitude: number;
/** @description Timezone Id */
// @ApiMember(DataType="Guid?", Description="Timezone Id", Name="Timezone", ParameterType="query")
public Timezone?: string;
public Estate: GeoEstateModel;
public GeoEstateId: string;
public GeoEstateStageId: string;
public GeoEstateStageName: string;
public IgnoreValidation: boolean;
public constructor(init?: Partial<GeoLocationModel>) { (Object as any).assign(this, init); }
}
export class ContactAddressModel
{
/** @description Location Details. */
// @ApiMember(DataType="GeoLocationModel", Description="Location Details.", Name="Location", ParameterType="query")
public Location: GeoLocationModel;
/** @description Is address postal. */
// @ApiMember(DataType="bool", Description="Is address postal.", Name="IsPostal", ParameterType="query")
public IsPostal: boolean;
/** @description Is address primary. */
// @ApiMember(DataType="bool", Description="Is address primary.", Name="IsPrimaryLocation", ParameterType="query")
public IsPrimaryLocation: boolean;
/** @description Is address registered. */
// @ApiMember(DataType="bool", Description="Is address registered.", Name="IsRegisteredLocation", ParameterType="query")
public IsRegisteredLocation: boolean;
/** @description Contact Address Id. */
// @ApiMember(DataType="Guid", Description="Contact Address Id.", Name="ContactAddressId", ParameterType="query")
public ContactAddressId: string;
/** @description Contact Address Suburb Name. */
// @ApiMember(DataType="string", Description="Contact Address Suburb Name.", Name="SuburbName", ParameterType="query")
public SuburbName: string;
/** @description Contact Address Street Name. */
// @ApiMember(DataType="string", Description="Contact Address Street Name.", Name="StateName", ParameterType="query")
public StateName: string;
/** @description Contact Country Name. */
// @ApiMember(DataType="string", Description="Contact Country Name.", Name="CountryName", ParameterType="query")
public CountryName: string;
public constructor(init?: Partial<ContactAddressModel>) { (Object as any).assign(this, init); }
}
export class PhoneModel
{
/** @description Phone Country Code. */
// @ApiMember(DataType="string", Description="Phone Country Code.", Name="CountryCode", ParameterType="query")
public CountryCode: string;
/** @description Phone Area Code. */
// @ApiMember(DataType="string", Description="Phone Area Code.", Name="AreaCode", ParameterType="query")
public AreaCode: string;
/** @description Phone Local Number. */
// @ApiMember(DataType="string", Description="Phone Local Number.", Name="LocalNumber", ParameterType="query")
public LocalNumber: string;
public constructor(init?: Partial<PhoneModel>) { (Object as any).assign(this, init); }
}
export class ContactDetailModel
{
/** @description Contact Method Id */
// @ApiMember(DataType="Guid", Description="Contact Method Id", Name="ContactMethodId", ParameterType="query")
public ContactMethodId: string;
/** @description Contact Method Name */
// @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="query")
public ContactMethodName: string;
/** @description Contact Address Details */
// @ApiMember(DataType="ContactAddressModel", Description="Contact Address Details", Name="ContactAddress", ParameterType="query")
public ContactAddress: ContactAddressModel;
/** @description Contact Phone Details */
// @ApiMember(DataType="PhoneModel", Description="Contact Phone Details", Name="ContactPhone", ParameterType="query")
public ContactPhone: PhoneModel;
/** @description Country id */
// @ApiMember(DataType="Guid", Description="Country id", Name="CountryId", ParameterType="query")
public CountryId?: string;
/** @description Contact Details */
// @ApiMember(DataType="string", Description="Contact Details", Name="ContactDetails", ParameterType="query")
public ContactDetails: string;
/** @description Notes */
// @ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")
public Notes: string;
/** @description Contact Details Code */
// @ApiMember(DataType="string", Description="Contact Details Code", Name="ContactDetailsCode", ParameterType="query")
public ContactDetailsCode: string;
/** @description Order of Contact Method Id */
// @ApiMember(DataType="int", Description="Order of Contact Method Id", Name="OrderContactMethod", ParameterType="query")
public OrderContactMethod: number;
/** @description Contact Method Id */
// @ApiMember(DataType="bool", Description="Contact Method Id", Name="IsPrimaryContactMethod", ParameterType="query")
public IsPrimaryContactMethod: boolean;
/** @description Is contact details an address */
// @ApiMember(DataType="bool", Description="Is contact details an address", Name="IsAddress", ParameterType="query")
public IsAddress: boolean;
/** @description Contact Contact Detail Id */
// @ApiMember(DataType="Guid", Description="Contact Contact Detail Id", Name="ContactContactDetailId", ParameterType="query")
public ContactContactDetailId: string;
/** @description Contact Id */
// @ApiMember(DataType="Guid", Description="Contact Id", Name="ContactId", ParameterType="query")
public ContactId: string;
/** @description Contact Details Id */
// @ApiMember(DataType="Guid", Description="Contact Details Id", Name="ContactDetailId", ParameterType="query")
public ContactDetailId: string;
/** @description Is contact details a primary location */
// @ApiMember(DataType="bool", Description="Is contact details a primary location", Name="IsPrimaryLocation", ParameterType="query")
public IsPrimaryLocation: boolean;
/** @description Is contact details a registered location */
// @ApiMember(DataType="bool", Description="Is contact details a registered location", Name="IsRegisteredLocation", ParameterType="query")
public IsRegisteredLocation: boolean;
/** @description Is contact details a postal address */
// @ApiMember(DataType="bool", Description="Is contact details a postal address", Name="IsPostal", ParameterType="query")
public IsPostal: boolean;
/** @description Is contact details a phone number */
// @ApiMember(DataType="bool", Description="Is contact details a phone number", Name="IsPhone", ParameterType="query")
public IsPhone: boolean;
/** @description Email Signature Id */
// @ApiMember(DataType="Guid", Description="Email Signature Id", Name="EmailSignatureId", ParameterType="query")
public EmailSignatureId: string;
/** @description Email Signature HTML */
// @ApiMember(DataType="string", Description="Email Signature HTML", Name="EmailSignatureHTML", ParameterType="query")
public EmailSignatureHTML: string;
/** @description Email Signature Text */
// @ApiMember(DataType="string", Description="Email Signature Text", Name="EmailSignatureText", ParameterType="query")
public EmailSignatureText: string;
/** @description API Key from Framework */
// @ApiMember(DataType="string", Description="API Key from Framework", Name="ApiFrameworkAlternateKey", ParameterType="query")
public ApiFrameworkAlternateKey: string;
public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}
export class UserProfileModel extends UserProfileSummaryModel
{
/** @description Contact Date of Birth (when person type) */
// @ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query")
public BirthDate?: string;
/** @description Contact marital status (when person type) */
// @ApiMember(DataType="string", Description="Contact marital status (when person type)", Name="MaritalStatusName", ParameterType="query")
public MaritalStatusName: string;
/** @description Contact gender (when person type) */
// @ApiMember(DataType="string", Description="Contact gender (when person type)", Name="GenderName", ParameterType="query")
public GenderName: string;
/** @description The Gender Guid of the contact. */
// @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
public GenderId?: string;
/** @description All contact details of the contact */
// @ApiMember(DataType="List<ContactDetailModel>", Description="All contact details of the contact", Name="ContactDetails", ParameterType="query")
public ContactDetails: ContactDetailModel[];
/** @description Primary Street Address */
// @ApiMember(DataType="ContactDetail", Description="Primary Street Address", Name="PrimaryStreetAddress ")
public PrimaryStreetAddress: ContactDetailModel;
/** @description Primary Postal Address */
// @ApiMember(DataType="ContactDetail", Description="Primary Postal Address", Name="PrimaryPostalAddress ")
public PrimaryPostalAddress: ContactDetailModel;
/** @description Primary Registered Address */
// @ApiMember(DataType="ContactDetail", Description="Primary Registered Address", Name="PrimaryRegisteredAddress ")
public PrimaryRegisteredAddress: ContactDetailModel;
/** @description Primary Email Address */
// @ApiMember(DataType="ContactDetail", Description="Primary Email Address", Name="PrimaryEmail ")
public PrimaryEmail: ContactDetailModel;
/** @description Primary Mobile Number */
// @ApiMember(DataType="ContactDetail", Description="Primary Mobile Number", Name="PrimaryMobile")
public PrimaryMobile: ContactDetailModel;
/** @description Primary Non-Mobile Number */
// @ApiMember(DataType="ContactDetail", Description="Primary Non-Mobile Number", Name="PrimaryPhone")
public PrimaryPhone: ContactDetailModel;
/** @description Primary Fax Number */
// @ApiMember(DataType="ContactDetail", Description="Primary Fax Number", Name="PrimaryFax")
public PrimaryFax: ContactDetailModel;
/** @description Primary Web Address */
// @ApiMember(DataType="ContactDetail", Description="Primary Web Address", Name="PrimaryWeb")
public PrimaryWeb: ContactDetailModel;
/** @description Social Media Twitter */
// @ApiMember(DataType="ContactDetail", Description="Social Media Twitter", Name="SocialMediaTwitter")
public SocialMediaTwitter: ContactDetailModel;
/** @description Social Media Facebook */
// @ApiMember(DataType="ContactDetail", Description="Social Media Facebook", Name="SocialMediaFacebook")
public SocialMediaFacebook: ContactDetailModel;
/** @description Social Media Instagram */
// @ApiMember(DataType="ContactDetail", Description="Social Media Instagram", Name="SocialMediaInstagram")
public SocialMediaInstagram: ContactDetailModel;
/** @description Have all connections to the contact been removed? */
// @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
public IsRemovedContact: boolean;
/** @description True if this is the users default profile. */
// @ApiMember(DataType="bool", Description="True if this is the users default profile.", Name="IsDefault", ParameterType="query")
public IsDefault: boolean;
/** @description True if the users email on this profile can be edited. */
// @ApiMember(DataType="bool", Description="True if the users email on this profile can be edited.", Name="IsEmailEditable", ParameterType="query")
public IsEmailEditable: boolean;
/** @description Primary image Content sent as a file stream contents (if not attached to the request) */
// @ApiMember(DataType="string", Description="Primary image Content sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContent")
public PrimaryImageContent: string;
/** @description Primary image Content type sent as a file stream contents (if not attached to the request) */
// @ApiMember(DataType="string", Description="Primary image Content type sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContentType")
public PrimaryImageContentType: string;
/** @description Primary image file name */
// @ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName")
public PrimaryImageFileName: string;
public constructor(init?: Partial<UserProfileModel>) { super(init); (Object as any).assign(this, init); }
}
/** @description Updates a Users Profile information' */
// @Api(Description="Updates a Users Profile information'")
export class AddOrUpdateUserProfile
{
public UserProfileId: string;
public UserProfile: UserProfileModel;
public constructor(init?: Partial<AddOrUpdateUserProfile>) { (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); }
}
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 AddOrUpdateUserProfileResponse
{
public Errors: ResponseError[];
/** @description Guid representing the object that is the User Profile Id in Eros. */
// @ApiMember(DataType="Guid", Description="Guid representing the object that is the 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<AddOrUpdateUserProfileResponse>) { (Object as any).assign(this, init); }
}
TypeScript AddOrUpdateUserProfile 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/profiles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UserProfile:
{
BirthDate: 0001-01-01,
MaritalStatusName: String,
GenderName: String,
GenderId: 00000000000000000000000000000000,
ContactDetails:
[
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
}
],
PrimaryStreetAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryPostalAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryRegisteredAddress:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryEmail:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryMobile:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryPhone:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryFax:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
PrimaryWeb:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaTwitter:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaFacebook:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
SocialMediaInstagram:
{
ContactMethodName: String,
ContactAddress:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
AddressFormatId: 4f7bf5b4-d77c-4ac7-99d6-7a575964480d,
Latitude: 0,
Longitude: 0,
Timezone: 00000000000000000000000000000000,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String,
IgnoreValidation: False
},
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,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiFrameworkAlternateKey: String
},
IsRemovedContact: False,
IsDefault: False,
IsEmailEditable: False,
PrimaryImageContent: String,
PrimaryImageContentType: String,
PrimaryImageFileName: String,
UserName: String,
ProfileName: String,
ContactFullName: String,
EmailAddress: String,
EmailSignature: String,
MobileNumber: String,
PhoneNumber: String,
ContactTypeName: String,
FirstName: String,
Surname: String,
Title: String,
LegalName: String,
TradingName: String,
Abn: String,
Acn: String,
Arbn: String,
GstRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsActiveContact: False
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}