POST api/Village/{village}/Invite

Invite one or more villagers to the specified village

Request Information

URI Parameters

Name	Description	Type	Additional information
village	Village ID	globally unique identifier	Required

Body Parameters

A list of people to invite

InvitationModel

Name	Description	Type	Additional information
Message	Custom message to put in the email. If no message is provided, a default message will be sent	string	String length: inclusive between 0 and 4096
Invitations	List of invitation recipients	Collection of InviteModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Invitations": [
    {
      "Name": "sample string 1",
      "Email": "sample string 2",
      "Role": 0
    },
    {
      "Name": "sample string 1",
      "Email": "sample string 2",
      "Role": 0
    }
  ]
}

application/xml, text/xml

Sample:

<InvitationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Invitations>
    <InviteModel>
      <Email>sample string 2</Email>
      <Name>sample string 1</Name>
      <Role>Revoked</Role>
    </InviteModel>
    <InviteModel>
      <Email>sample string 2</Email>
      <Name>sample string 1</Name>
      <Role>Revoked</Role>
    </InviteModel>
  </Invitations>
  <Message>sample string 1</Message>
</InvitationModel>

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'MultipartMediaTypeFormatter' to write type 'InvitationModel'.

Response Information

Resource Description

Dictionary of string [key] and string [value]

Response Formats

application/json, text/json

Sample:

{
  "sample string 1": "sample string 2",
  "sample string 3": "sample string 4"
}

application/xml, text/xml

Sample:

<ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringstring>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
  </KeyValueOfstringstring>
</ArrayOfKeyValueOfstringstring>