GET api/Invitation/ByVillage?name={name}
Check for an invitation for the current user for a village named 'name'
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name | string |
Required |
Body Parameters
None.
Response Information
Resource Description
InvitationDetailModelName | 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": "f5ab0ae7-22b5-4582-8527-f02a23f8e1fb", "Name": "sample string 2", "Role": "sample string 3", "VillageId": "1058829a-6e19-483f-9002-ed24e0aa9caf", "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>f5ab0ae7-22b5-4582-8527-f02a23f8e1fb</InvitationId> <InviteeEmail>sample string 5</InviteeEmail> <Name>sample string 2</Name> <Role>sample string 3</Role> <VillageId>1058829a-6e19-483f-9002-ed24e0aa9caf</VillageId> </InvitationDetailModel>