| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Reason":"Authorised","CanSend":false,"Remaining":0,"RemainingCredits":0,"Detail":"String","CanVideoCall":false,"CanSendPhotos":false,"CanSendGifts":false,"SenderIsDiamond":false,"ReceiverIsDiamond":false,"SenderProfileMatching":false,"ReceiverProfileMatching":false,"ReceiverMemberLevel":{"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SenderMemberLevel":{"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"TimeToReset":0,"ConversationKey":"String","DefEn":"String","UpgradeAction":"None","IsCreditSend":false,"MessageBanExpiry":"\/Date(-62135596800000-0000)\/","SendPhotosBanExpiry":"\/Date(-62135596800000-0000)\/","TimeStamp":"\/Date(-62135596800000-0000)\/"}