Back

GET individuals/{individualId}/surveys

Read a list of surveys for an individual. PM

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
individualId globally unique identifier

ID of the individual whose surveys are to be read.

Body Parameters

None.

Response Information

Resource Description (SurveyList)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
SurveyName string ReadOnly

Name of the given survey.
ID integer ReadOnly

ID of the given survery.
ItemID globally unique identifier ReadOnly

ID of the item in the survery.
ItemType byte ReadOnly

Type of item for the given survery.
DateRequested date ReadOnly

Date the given survey was requested.
DateRequired date ReadOnly

Date the given survery is required to be completed.
DaysDue integer ReadOnly

Days until the given survery is due.
ItemName string ReadOnly

Name of the item in the given survery.
Item_ID globally unique identifier ReadOnly

ID of the item.
SampleDate date ReadOnly

Sample Date of the given survey.
Status string ReadOnly

Status of the given survey
StatusDate date ReadOnly

Status date for the given survey.
DateCompleted date ReadOnly

Date the given survey was completed.
ReviewerDate date ReadOnly

Date the given survey was reivewed
ReviewerName string ReadOnly

Name of the reviewer.
ReviewerID globally unique identifier ReadOnly

ID of the reviewer.

Response Formats

application/xml, text/xml

Sample
<SurveyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <DateCompleted>2024-04-18T17:53:25.4171777+00:00</DateCompleted>
  <DateRequested>2024-04-18T17:53:25.4171777+00:00</DateRequested>
  <DateRequired>2024-04-18T17:53:25.4171777+00:00</DateRequired>
  <DaysDue>1</DaysDue>
  <ID>2</ID>
  <ItemID>415de586-277e-45fa-b70b-d2bad918a755</ItemID>
  <ItemName>sample string 5</ItemName>
  <ItemType>64</ItemType>
  <Item_ID>0fa9686b-ef86-41e2-afd4-570af88ee974</Item_ID>
  <ReviewerDate>2024-04-18T17:53:25.4171777+00:00</ReviewerDate>
  <ReviewerID>b3cb4703-6702-4fb5-a304-07de23e3e671</ReviewerID>
  <ReviewerName>sample string 8</ReviewerName>
  <SampleDate>2024-04-18T17:53:25.4171777+00:00</SampleDate>
  <Status>sample string 7</Status>
  <StatusDate>2024-04-18T17:53:25.4171777+00:00</StatusDate>
  <SurveyName>sample string 1</SurveyName>
</SurveyList>

application/json, text/json

Sample
{
  "SurveyName": "sample string 1",
  "ID": 2,
  "ItemID": "415de586-277e-45fa-b70b-d2bad918a755",
  "ItemType": 64,
  "DateRequested": "2024-04-18T17:53:25.4171777+00:00",
  "DateRequired": "2024-04-18T17:53:25.4171777+00:00",
  "DaysDue": 1,
  "ItemName": "sample string 5",
  "Item_ID": "0fa9686b-ef86-41e2-afd4-570af88ee974",
  "SampleDate": "2024-04-18T17:53:25.4171777+00:00",
  "Status": "sample string 7",
  "StatusDate": "2024-04-18T17:53:25.4171777+00:00",
  "DateCompleted": "2024-04-18T17:53:25.4171777+00:00",
  "ReviewerDate": "2024-04-18T17:53:25.4171777+00:00",
  "ReviewerName": "sample string 8",
  "ReviewerID": "b3cb4703-6702-4fb5-a304-07de23e3e671"
}