RHP_API

<back to all web services

CreateUserChatroomBan

Creates a temporary ban for a chat room user.

Requires Authentication
The following routes are available for this service:
POST/Profile/{id}/ChatRoomBan
CreateUserChatroomBan Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
BanTypebodyChatRoomBanTypeNo
DurationbodyintNo
RoomIdentifierbodystringNo
GenericResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Profile/{id}/ChatRoomBan HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	BanType: Limited,
	Duration: 0,
	RoomIdentifier: String,
	Result: False
}