POST v1/Participant

Creates a Participant

Request Information

URI Parameters

None.

Body Parameters

An object representing the Participant.

Participant
NameDescriptionTypeAdditional information
Id

string

None.
Metadata

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "Metadata": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

text/html

Sample: 
{"Id":"sample string 1","Metadata":{"sample string 1":"sample string 2","sample string 3":"sample string 4"}}

application/xml, text/xml

Sample: 
<Participant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models">
  <Id>sample string 1</Id>
  <Metadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Metadata>
</Participant>

Response Information

Resource Description

A response containing the new Participant's unique id, or validation errors if the Participant could not be created.

ParticipantPostResponse

None.

Response Codes

  • 201 Created: Participant successfully created.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json, text/html

Sample: 
{}

application/xml, text/xml

Sample: 
<ParticipantPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Responses" />