GET api/Profile

Retrieve the current user's profile

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ProfileModel

Name	Description	Type	Additional information
Id	User ID	globally unique identifier	None.
FirstName	User's first name	string	Required String length: inclusive between 0 and 120
LastName	User's last name	string	Required String length: inclusive between 0 and 120
Email	User's email address	string	String length: inclusive between 0 and 255
PendingEmail	Pending email address change	string	String length: inclusive between 0 and 255
PrivateEmail	User wants to keep their email address private?	boolean	None.
PhoneNumber	User's Phone Number	string	String length: inclusive between 0 and 60
Address	User's Address	OptionalAddressModel	None.
HasPassword	If true, the user has a password. If false, the user is social login only	boolean	None.
EmailConfirmed	If true, the user has confirmed their email address	boolean	None.
SocialLogins	List of social login providers linked to this account	Collection of string	None.
TrialEligible	Indicates if the user is eligible for a trial village	boolean	None.
Preferences	User Preferences (non-village)	UpdatePreferencesModel	None.
TimeZone	User's preferred timezone name (e.g. America/New_York), but for setting the value can use "Eastern Standard Time" (but not "Eastern Daylight Time").	string	None.
CanonicalTimeZone	User's preferred time zone name, canonicalized (e.g. will always America/New York)	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "5894331a-b716-481a-aa9f-6a94b74c1d33",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "PendingEmail": "sample string 5",
  "PrivateEmail": true,
  "PhoneNumber": "sample string 7",
  "Address": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5",
    "Country": "sample string 6"
  },
  "HasPassword": true,
  "EmailConfirmed": true,
  "SocialLogins": [
    "sample string 1",
    "sample string 2"
  ],
  "TrialEligible": true,
  "Preferences": {
    "AdminPush": 1,
    "AdminEmail": 1
  },
  "TimeZone": "sample string 11",
  "CanonicalTimeZone": "America/New_York"
}

application/xml, text/xml

Sample:

<ProfileModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zip>sample string 5</d2p1:Zip>
  </Address>
  <Email>sample string 4</Email>
  <EmailConfirmed>true</EmailConfirmed>
  <FirstName>sample string 2</FirstName>
  <HasPassword>true</HasPassword>
  <Id>5894331a-b716-481a-aa9f-6a94b74c1d33</Id>
  <LastName>sample string 3</LastName>
  <PendingEmail>sample string 5</PendingEmail>
  <PhoneNumber>sample string 7</PhoneNumber>
  <Preferences>
    <AdminEmail>NewVillages</AdminEmail>
    <AdminPush>NewVillages</AdminPush>
  </Preferences>
  <PrivateEmail>true</PrivateEmail>
  <SocialLogins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SocialLogins>
  <TimeZone>sample string 11</TimeZone>
  <TrialEligible>true</TrialEligible>
</ProfileModel>