GET v1/Participant/{id}

Retrieves a Participant by their id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the Participant requested.

 string

Required

Body Parameters

None.

Response Information

Resource Description

The Participant, if it exists. Otherwise a 404 error.

Participant
NameDescriptionTypeAdditional information
Id

string

None.
Metadata

Dictionary of string [key] and string [value]

None.

Response Codes

  • 200 OK: Requested Participant successfully returned.
  • 401 Unauthorized:
  • 404 NotFound: Requested Participant does not exist.
  • 500 InternalServerError:

Response 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>