GET api/Invitation
Get a list of the user's invitations
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of 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": "1618d585-da28-4225-ad36-79fe0ded39f7", "Name": "sample string 2", "Role": "sample string 3", "VillageId": "70614c0e-d0bf-48b2-a9d5-554530f98170", "InviteeEmail": "sample string 5", "Business": "sample string 6" }, { "InvitationId": "1618d585-da28-4225-ad36-79fe0ded39f7", "Name": "sample string 2", "Role": "sample string 3", "VillageId": "70614c0e-d0bf-48b2-a9d5-554530f98170", "InviteeEmail": "sample string 5", "Business": "sample string 6" } ]
application/xml, text/xml
Sample:
<ArrayOfInvitationDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <InvitationDetailModel> <Business>sample string 6</Business> <InvitationId>1618d585-da28-4225-ad36-79fe0ded39f7</InvitationId> <InviteeEmail>sample string 5</InviteeEmail> <Name>sample string 2</Name> <Role>sample string 3</Role> <VillageId>70614c0e-d0bf-48b2-a9d5-554530f98170</VillageId> </InvitationDetailModel> <InvitationDetailModel> <Business>sample string 6</Business> <InvitationId>1618d585-da28-4225-ad36-79fe0ded39f7</InvitationId> <InviteeEmail>sample string 5</InviteeEmail> <Name>sample string 2</Name> <Role>sample string 3</Role> <VillageId>70614c0e-d0bf-48b2-a9d5-554530f98170</VillageId> </InvitationDetailModel> </ArrayOfInvitationDetailModel>