ConsumerApi

<back to all web services

ProfileGetRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/profile
ProfileGetResponse Parameters:
NameParameterData TypeRequiredDescription
UserProfileformUserProfileDtoYes
UserProfileDto Parameters:
NameParameterData TypeRequiredDescription
LocaleformLocaleNo
UserGuidformGuidNo
FirstNameformstringNo
LastNameformstringNo
ProfilePhotoUrlformstringNo
MobilePhoneformstringYes
MobilePhoneVerifiedformboolNo
EmailformstringNo
EmailVerifiedformboolNo
HasPasswordformboolNo
DateOfBirthformDateOfBirthYes
SexformSex?No
HomeformHomeLocationYes
ShowDistancesInformDistanceUnitNo
ManagesPlacesInBusinessWebformboolNo
PointsTotalformlongNo
Locale Enum:
EnUs
NbNo
DateOfBirth Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
MonthformintNo
DayOfMonthformintNo
Sex Enum:
Male
Female
HomeLocation Parameters:
NameParameterData TypeRequiredDescription
AddressformUserAddressYes
LatitudeformfloatNo
LongitudeformfloatNo
UserAddress Parameters:
NameParameterData TypeRequiredDescription
StreetNameformstringYes
StreetNumberformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
DistanceUnit Enum:
Kilometer
Mile

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /profile HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"userProfile":{"locale":"EnUs","firstName":"String","lastName":"String","profilePhotoUrl":"String","mobilePhone":"String","mobilePhoneVerified":false,"email":"String","emailVerified":false,"hasPassword":false,"dateOfBirth":{"year":0,"month":0,"dayOfMonth":0},"sex":"Male","home":{"address":{"streetName":"String","streetNumber":"String","postalCode":"String","region":"String","countryCode":"String"},"latitude":0,"longitude":0},"showDistancesIn":"Kilometer","managesPlacesInBusinessWeb":false,"pointsTotal":0}}