RHP_API

<back to all web services

ValidatePhoneNumber

Validates the sent phone number

Requires Authentication
The following routes are available for this service:
POST/User/Phone/Validate
ValidatePhoneNumber Parameters:
NameParameterData TypeRequiredDescription
PhoneNumberbodystringNoThe phone number, can start with a '0'
PhoneAlpha2CodebodystringNo2 character country code eg. AU, VN
PhoneCountryCodebodystringNoThe countries phone code, the starting '+' is optional. eg. AU=+61, US=+1
GenericResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo

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/Validate HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ValidatePhoneNumber xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <PhoneAlpha2Code>String</PhoneAlpha2Code>
  <PhoneCountryCode>String</PhoneCountryCode>
  <PhoneNumber>String</PhoneNumber>
</ValidatePhoneNumber>

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

<GenericResponseOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <Result>false</Result>
</GenericResponseOfboolean>