RHP_API

<back to all web services

GenerateInvitationToken

DEPRECATED: Get join request invitation token, to facilitate a user to join a club.

Requires Authentication
The following routes are available for this service:
POST/User/Club/{ClubID}/InvitationToken/
GenerateInvitationToken Parameters:
NameParameterData TypeRequiredDescription
ClubIDpathintNo
RecipientIDbodylongNo
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/Club/{ClubID}/InvitationToken/ HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateInvitationToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <ClubID>0</ClubID>
  <RecipientID>0</RecipientID>
</GenerateInvitationToken>

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

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