GET v1/Surveys/{surveyId}/InvitationTemplates

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser SampleManager DemoUser

Permissions required to make this request: SurveyEmailInvitationTemplate.Read Survey.Read

Has survey type usage restrictions online

Retrieves the invitation templates for the specified survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId		string	Required

Body Parameters

None.

Response Information

Resource Description

Response Message

Collection of InvitationTemplateModel

Name	Description	Type	Additional information
Id	Invitation template id	integer	None.
InvitationType	Invitation type. 1 = Invitation. 2 = Reminder.	integer	None.
Name	Name of the invitation template	string	Max length: 150
Subject	Subject of the invitation	string	Max length: 150
Body	Body of the invitation	string	Max length: 2147483647

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "InvitationType": 2,
    "Name": "sample string 3",
    "Subject": "sample string 4",
    "Body": "sample string 5"
  },
  {
    "Id": 1,
    "InvitationType": 2,
    "Name": "sample string 3",
    "Subject": "sample string 4",
    "Body": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInvitationTemplateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InvitationTemplateModel>
    <Body>sample string 5</Body>
    <InvitationType>2</InvitationType>
    <Name>sample string 3</Name>
    <Subject>sample string 4</Subject>
    <Id>1</Id>
  </InvitationTemplateModel>
  <InvitationTemplateModel>
    <Body>sample string 5</Body>
    <InvitationType>2</InvitationType>
    <Name>sample string 3</Name>
    <Subject>sample string 4</Subject>
    <Id>1</Id>
  </InvitationTemplateModel>
</ArrayOfInvitationTemplateModel>