GET v1/Participant

Return top level information about a Participant

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Participant
NameDescriptionTypeAdditional information
Id

string

None.
Metadata

Dictionary of string [key] and string [value]

None.

Response Codes

  • 200 OK: Information about all Participants returned successfully
  • 401 Unauthorized:
  • 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"
    }
  },
  {
    "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"}},{"Id":"sample string 1","Metadata":{"sample string 1":"sample string 2","sample string 3":"sample string 4"}}]

application/xml, text/xml

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