| All Verbs | /api/profile/business |
|---|
namespace Eros.Saguna.Common.WebAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type AddBusinessProfileResponse() =
///<summary>
///Short description of the overall status of the web service response.
///</summary>
[<ApiMember(DataType="string", Description="Short description of the overall status of the web service response.", Name="Message", ParameterType="query")>]
member val Message:String = null with get,set
///<summary>
///Holds a code representing the exception type.
///</summary>
[<ApiMember(DataType="string", Description="Holds a code representing the exception type.", Name="ErrorCode", ParameterType="query")>]
member val ErrorCode:String = null with get,set
///<summary>
///Details of 1 or more validation errors from the web service
///</summary>
[<ApiMember(DataType="List<ResponseError>", Description="Details of 1 or more validation errors from the web service", Name="Errors", ParameterType="query")>]
member val Errors:ResizeArray<ResponseError> = null with get,set
///<summary>
///Guid representing the object that is the Businesses User Profile Id in Eros.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid representing the object that is the Businesses User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")>]
member val UserProfileId:Guid = new Guid() with get,set
///<summary>
///Service Stack Response Status.
///</summary>
[<ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type LocationCoordinatesModel() =
///<summary>
///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
///</summary>
[<ApiMember(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", ParameterType="query")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
///</summary>
[<ApiMember(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", ParameterType="query")>]
member val Longitude:Double = new Double() with get,set
///<summary>
///The altitude of an address - the altitude above sea level."
///</summary>
[<ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")>]
member val Altitude:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Accuracy of the latitude and longitude.
///</summary>
[<ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")>]
member val Accuracy:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Accurancy of the Altitude.
///</summary>
[<ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")>]
member val AltitudeAccuracy:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Direction you are heading.
///</summary>
[<ApiMember(Description="Direction you are heading.", ParameterType="query")>]
member val Heading:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Speed you are going.
///</summary>
[<ApiMember(Description="Speed you are going.", ParameterType="query")>]
member val Speed:Nullable<Double> = new Nullable<Double>() with get,set
///<summary>
///Speed your altitude is ascending/descending at.
///</summary>
[<ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")>]
member val VerticalSpeed:Nullable<Double> = new Nullable<Double>() with get,set
[<AllowNullLiteral>]
type AddressModel() =
///<summary>
///The distance between this project and another specified set of gps coordinates.
///</summary>
[<ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="body")>]
member val DistanceAway:Double = new Double() with get,set
///<summary>
///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
///</summary>
[<ApiMember(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", Name="Latitude", ParameterType="body")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
///</summary>
[<ApiMember(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", Name="Longitude", ParameterType="body")>]
member val Longitude:Double = new Double() with get,set
///<summary>
///Address Format Id Guid - this will be determined by the service.
///</summary>
[<ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="body")>]
member val AddressFormatId:Guid = new Guid() with get,set
///<summary>
///Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
///</summary>
[<ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="body")>]
member val SuburbId:Guid = new Guid() with get,set
///<summary>
///The suburb name.
///</summary>
[<ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")>]
member val SuburbName:String = null with get,set
///<summary>
///The shortened State Name e.g Vic for Victoria.
///</summary>
[<ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")>]
member val StateShortName:String = null with get,set
///<summary>
///The suburb postcode.
///</summary>
[<ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")>]
member val PostCode:String = null with get,set
///<summary>
///Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
///</summary>
[<ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="body")>]
member val CountryId:Guid = new Guid() with get,set
///<summary>
///the name of the country the address is within.
///</summary>
[<ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="body")>]
member val CountryName:String = null with get,set
///<summary>
///ISO Country Code.
///</summary>
[<ApiMember(Description="ISO Country Code.", ParameterType="query")>]
member val ISOCountryCode:String = null with get,set
///<summary>
///The address Lot number.
///</summary>
[<ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")>]
member val LotNumber:String = null with get,set
///<summary>
///The address Sub Unit number.
///</summary>
[<ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")>]
member val SubUnit:String = null with get,set
///<summary>
///The address building number.
///</summary>
[<ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")>]
member val BuildingNumber:String = null with get,set
///<summary>
///The address street number.
///</summary>
[<ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")>]
member val StreetNumber:String = null with get,set
///<summary>
///The address street name including street type.
///</summary>
[<ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")>]
member val StreetName:String = null with get,set
///<summary>
///A formatted address Line 1.
///</summary>
[<ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")>]
member val AddressLineOne:String = null with get,set
///<summary>
///A formatted address Line 2.
///</summary>
[<ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")>]
member val AddressLineTwo:String = null with get,set
///<summary>
///The full address string.
///</summary>
[<ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")>]
member val AddressFull:String = null with get,set
///<summary>
///True if the address is a physical location.
///</summary>
[<ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="body")>]
member val IsPhysical:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Notes about the address.
///</summary>
[<ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")>]
member val Notes:String = null with get,set
///<summary>
///If true, the address is eligible for having its coordinates calculated/updated.
///</summary>
[<ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="body")>]
member val AutoMapCoordinates:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Location Coordinates for the address.
///</summary>
[<ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")>]
member val LocationCoordinates:LocationCoordinatesModel = null with get,set
[<AllowNullLiteral>]
type ContactAddressModel() =
///<summary>
///Address Details
///</summary>
[<ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")>]
member val Address:AddressModel = null with get,set
///<summary>
///True if this is a postal address.
///</summary>
[<ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")>]
member val IsPostal:Boolean = new Boolean() with get,set
///<summary>
///True if this is the primary address.
///</summary>
[<ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")>]
member val IsPrimaryLocation:Boolean = new Boolean() with get,set
///<summary>
///True if this address is the registered tax address.
///</summary>
[<ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")>]
member val IsRegisteredLocation:Boolean = new Boolean() with get,set
///<summary>
///Suburb Name
///</summary>
[<ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")>]
member val SuburbName:String = null with get,set
///<summary>
///State Name
///</summary>
[<ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")>]
member val StateName:String = null with get,set
///<summary>
///Country Name
///</summary>
[<ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")>]
member val CountryName:String = null with get,set
[<AllowNullLiteral>]
type PhoneModel() =
///<summary>
///Country Code
///</summary>
[<ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")>]
member val CountryCode:String = null with get,set
///<summary>
///Area Code
///</summary>
[<ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")>]
member val AreaCode:String = null with get,set
///<summary>
///Local Number
///</summary>
[<ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")>]
member val LocalNumber:String = null with get,set
[<AllowNullLiteral>]
type ContactDetailModel() =
///<summary>
///Id of the Contact Method
///</summary>
[<ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")>]
member val ContactMethodId:Guid = new Guid() with get,set
///<summary>
///Contact Method Name
///</summary>
[<ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")>]
member val ContactMethodName:String = null with get,set
///<summary>
///If the contact method is an address, this will contain the address details.
///</summary>
[<ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")>]
member val ContactAddress:ContactAddressModel = null with get,set
///<summary>
///If the contact method is a phone, this will contain the phone details
///</summary>
[<ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")>]
member val ContactPhone:PhoneModel = null with get,set
///<summary>
///Id of the country
///</summary>
[<ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")>]
member val CountryId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///A summary string representing the contact details
///</summary>
[<ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")>]
member val ContactDetails:String = null with get,set
///<summary>
///Notes about the contact details
///</summary>
[<ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")>]
member val Notes:String = null with get,set
///<summary>
///Area Code if contact details are a phone number
///</summary>
[<ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")>]
member val ContactDetailsCode:String = null with get,set
///<summary>
///Order number of the contact method
///</summary>
[<ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")>]
member val OrderContactMethod:Int32 = new Int32() with get,set
///<summary>
///True if this is the primary contact method
///</summary>
[<ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")>]
member val IsPrimaryContactMethod:Boolean = new Boolean() with get,set
///<summary>
///True if this contact method is an address
///</summary>
[<ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")>]
member val IsAddress:Boolean = new Boolean() with get,set
///<summary>
///Updates a Users Profile information'
///</summary>
[<Api(Description="Updates a Users Profile information'")>]
[<AllowNullLiteral>]
type SaveUserProfile() =
///<summary>
///The users profile Guid.
///</summary>
[<ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")>]
member val UserProfileId:Guid = new Guid() with get,set
///<summary>
///The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.
///</summary>
[<ApiMember(DataType="Guid", Description="The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.", IsRequired=true, Name="UserId", ParameterType="query")>]
member val UserId:Guid = new Guid() with get,set
///<summary>
///The users contact Guid.
///</summary>
[<ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///The users profile name.
///</summary>
[<ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")>]
member val ProfileName:String = null with get,set
///<summary>
///The users (contact) title.
///</summary>
[<ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")>]
member val Title:String = null with get,set
///<summary>
///The users (contact) first name(s).
///</summary>
[<ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")>]
member val FirstName:String = null with get,set
///<summary>
///The users (contact) surname.
///</summary>
[<ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")>]
member val Surname:String = null with get,set
///<summary>
///The contact profile description.
///</summary>
[<ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")>]
member val Description:String = null with get,set
///<summary>
///The contacts profession/trade/industry details.
///</summary>
[<ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")>]
member val EmploymentIndustry:String = null with get,set
///<summary>
///The contact details of who they work/subcontract for.
///</summary>
[<ApiMember(DataType="string", Description="The contact details of who they work/subcontract for.", Name="EmploymentRole", ParameterType="query")>]
member val EmploymentRole:String = null with get,set
///<summary>
///The contacts work area/suburbs.
///</summary>
[<ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")>]
member val EmploymentGeographicArea:String = null with get,set
///<summary>
///The contacts timezone.
///</summary>
[<ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")>]
member val Timezone:Guid = new Guid() with get,set
///<summary>
///A list of the contact details for the contact. Note: an email must always be set for a business.
///</summary>
[<ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact. Note: an email must always be set for a business.", IsRequired=true, Name="ContactDetails", ParameterType="query")>]
member val ContactDetails:ResizeArray<ContactDetailModel> = null with get,set
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactType")>]
member val ContactType:Guid = new Guid() with get,set
///<summary>
///Legal name of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")>]
member val LegalName:String = null with get,set
///<summary>
///Trading name of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")>]
member val TradingName:String = null with get,set
///<summary>
///Abn of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Abn of contact linked to the profile", Name="Abn")>]
member val Abn:String = null with get,set
///<summary>
///Acn of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Acn of contact linked to the profile", Name="Acn")>]
member val Acn:String = null with get,set
///<summary>
///Arbn of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Arbn of contact linked to the profile", Name="Arbn")>]
member val Arbn:String = null with get,set
///<summary>
///Indicates if the Contact is registered for GST.
///</summary>
[<ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")>]
member val GstRegistered:Boolean = new Boolean() with get,set
///<summary>
///The Gender Guid of the contact.
///</summary>
[<ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")>]
member val GenderId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Updates a Users Profile information'
///</summary>
[<Api(Description="Updates a Users Profile information'")>]
[<AllowNullLiteral>]
type AddBusinessProfile() =
///<summary>
///The users business profile information to link to their user ID.
///</summary>
[<ApiMember(DataType="SaveUserProfile", Description="The users business profile information to link to their user ID.", Name="BusinessProfile", ParameterType="query")>]
member val BusinessProfile:SaveUserProfile = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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: text/csv
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"}}}