POST | /User/Phone/Verification |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VerificationCode | body | string | No | |
IsVisible | body | bool | No | |
IsSmsOnly | body | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsVerified | form | bool | No | If true the user's phone number has been verified. |
UserCountry | form | string | No | The user's profile Country. |
UserCountryCode | form | string | No | The user's profile Country Code. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PhoneNumber | form | string | No | The phone number, can start with a '0' |
IsVisible | form | bool | No | If true the user's phone number will be displayed on their profile |
IsSmsOnly | form | bool | No | If true a note will be added to the user's open profile next to the phone number. |
PhoneAlpha2Code | form | string | No | 2 character country code eg. AU, VN |
PhoneCountryCode | form | string | No | The countries phone code, the starting '+' is optional. eg. AU=+61, US=+1 |
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 /User/Phone/Verification HTTP/1.1
Host: tstsrvs.redhotpie.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
VerificationCode: String,
IsVisible: False,
IsSmsOnly: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { IsVerified: False, UserCountry: String, UserCountryCode: String, PhoneNumber: String, IsVisible: False, IsSmsOnly: False, PhoneAlpha2Code: String, PhoneCountryCode: String }