RHP_API

<back to all web services

VerifyUserPhone

Validates the Verification Code submitted. Also updates the Visibility and SMSOnly setting.

Requires Authentication
The following routes are available for this service:
POST/User/Phone/Verification
VerifyUserPhone Parameters:
NameParameterData TypeRequiredDescription
VerificationCodebodystringNo
IsVisiblebodyboolNo
IsSmsOnlybodyboolNo
UserPhone Parameters:
NameParameterData TypeRequiredDescription
IsVerifiedformboolNoIf true the user's phone number has been verified.
UserCountryformstringNoThe user's profile Country.
UserCountryCodeformstringNoThe user's profile Country Code.
UserPhoneBasic Parameters:
NameParameterData TypeRequiredDescription
PhoneNumberformstringNoThe phone number, can start with a '0'
IsVisibleformboolNoIf true the user's phone number will be displayed on their profile
IsSmsOnlyformboolNoIf true a note will be added to the user's open profile next to the phone number.
PhoneAlpha2CodeformstringNo2 character country code eg. AU, VN
PhoneCountryCodeformstringNoThe 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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<VerifyUserPhone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <IsSmsOnly>false</IsSmsOnly>
  <IsVisible>false</IsVisible>
  <VerificationCode>String</VerificationCode>
</VerifyUserPhone>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserPhone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <IsSmsOnly>false</IsSmsOnly>
  <IsVisible>false</IsVisible>
  <PhoneAlpha2Code>String</PhoneAlpha2Code>
  <PhoneCountryCode>String</PhoneCountryCode>
  <PhoneNumber>String</PhoneNumber>
  <IsVerified>false</IsVerified>
  <UserCountry>String</UserCountry>
  <UserCountryCode>String</UserCountryCode>
</UserPhone>