| GET | /Profile/{ID}/MessageAuthorised |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | path | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reason | form | UserNotificationReason | No | The descriptor for CanSend, used to provide additional information to the client. |
| CanSend | form | bool | No | If true the current user can send. |
| Remaining | form | int | No | Number of conversations remaining for the Sender. |
| RemainingCredits | form | int | No | Number of conversations credit remaining for the Sender. |
| Detail | form | string | No | Detail of permissions. DEBUG ONLY |
| CanVideoCall | form | bool | No | If true the Sender can use Video with the Receiver |
| CanSendPhotos | form | bool | No | If true the Sender can send Photos to the Receiver |
| CanSendGifts | form | bool | No | If true the Sender can send Gifts to the Receiver |
| SenderIsDiamond | form | bool | No | If true the Sender is a Diamond Club member |
| ReceiverIsDiamond | form | bool | No | If true the Sender is a Diamond Club member |
| SenderProfileMatching | form | bool | No | Is the Sender a profile match with the Receiver. If true, the message should display in the Sender's Matching filter. |
| ReceiverProfileMatching | form | bool | No | Is the Receiver a profile match with the Sender. If true, the message should display in the Receiver's Matching filter. |
| ReceiverMemberLevel | form | LookupValueBase | No | The Memberlevel of the Receiver |
| SenderMemberLevel | form | LookupValueBase | No | The Memberlevel of the Sender |
| TimeToReset | form | double | No | Time remaining until reset. |
| ConversationKey | form | string | No | Unique key for a user's conversation. |
| DefEn | form | string | No | For Debug purpose only. |
| UpgradeAction | form | MessageUpgradeType | No | If a user can not send a message, this is the upgrade path. |
| IsCreditSend | form | bool | No | If true the user will be charged a credit. |
| MessageBanExpiry | form | DateTime? | No | |
| SendPhotosBanExpiry | form | DateTime? | No | |
| TimeStamp | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | int | No | |
| Text | form | string | No | |
| TextAbbr | form | string | No | |
| ListID | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Profile/{ID}/MessageAuthorised HTTP/1.1
Host: tstsrvs.redhotpie.com.au
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserNotificationMessageAuthorisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
<CanSend>false</CanSend>
<CanSendGifts>false</CanSendGifts>
<CanSendPhotos>false</CanSendPhotos>
<CanVideoCall>false</CanVideoCall>
<ConversationKey>String</ConversationKey>
<DefEn>String</DefEn>
<Detail>String</Detail>
<IsCreditSend>false</IsCreditSend>
<MessageBanExpiry>0001-01-01T00:00:00</MessageBanExpiry>
<Reason>Authorised</Reason>
<ReceiverIsDiamond>false</ReceiverIsDiamond>
<ReceiverMemberLevel xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
<d2p1:ListID>0</d2p1:ListID>
<d2p1:Text>String</d2p1:Text>
<d2p1:TextAbbr>String</d2p1:TextAbbr>
<d2p1:Value>0</d2p1:Value>
</ReceiverMemberLevel>
<ReceiverProfileMatching>false</ReceiverProfileMatching>
<Remaining>0</Remaining>
<RemainingCredits>0</RemainingCredits>
<SendPhotosBanExpiry>0001-01-01T00:00:00</SendPhotosBanExpiry>
<SenderIsDiamond>false</SenderIsDiamond>
<SenderMemberLevel xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
<d2p1:ListID>0</d2p1:ListID>
<d2p1:Text>String</d2p1:Text>
<d2p1:TextAbbr>String</d2p1:TextAbbr>
<d2p1:Value>0</d2p1:Value>
</SenderMemberLevel>
<SenderProfileMatching>false</SenderProfileMatching>
<TimeStamp>0001-01-01T00:00:00</TimeStamp>
<TimeToReset>0</TimeToReset>
<UpgradeAction>None</UpgradeAction>
</UserNotificationMessageAuthorisation>