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 |
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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: tstsrvs.redhotpie.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: UpdateUserPhone
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<UpdateUserPhone 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>
</UpdateUserPhone>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <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> </soap:Body> </soap:Envelope>