GET api/Invitation/{code}

Get the details of an invitation based on its invitation code

Request Information

URI Parameters

Name	Description	Type	Additional information
code	The invitation code to retrieve	string	Required

Body Parameters

None.

Response Information

Resource Description

InvitationDetailModel

Name	Description	Type	Additional information
InvitationId	Invitation's unique ID	globally unique identifier	None.
Name	Name of the village	string	None.
Role	The role into which the user has been invited	string	None.
VillageId	The ID of the village	globally unique identifier	None.
InviteeEmail	The email address of the invitee	string	None.
Business	Invitation's business name, if applicable	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InvitationId": "ae7255d2-23f6-469a-9c27-597edcaa71d5",
  "Name": "sample string 2",
  "Role": "sample string 3",
  "VillageId": "095c9e09-db1a-42de-a9b8-692f1e65740c",
  "InviteeEmail": "sample string 5",
  "Business": "sample string 6"
}

application/xml, text/xml

Sample:

<InvitationDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Business>sample string 6</Business>
  <InvitationId>ae7255d2-23f6-469a-9c27-597edcaa71d5</InvitationId>
  <InviteeEmail>sample string 5</InviteeEmail>
  <Name>sample string 2</Name>
  <Role>sample string 3</Role>
  <VillageId>095c9e09-db1a-42de-a9b8-692f1e65740c</VillageId>
</InvitationDetailModel>