Back

GET surveys?surveyId={surveyId}

Read information from a single survey. PM

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
surveyId integer Required

ID of the survey to be read.

Body Parameters

None.

Response Information

Resource Description (SurveyInfo)

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

ID of the given survey.
Name string ReadOnly

Name of the given survey
StartDate date ReadOnly

Start date of the given survey.
EndDate date ReadOnly

End date of the given survey.
DateRequired date ReadOnly

Date the given survey is required to be completed.
DateCompleted date ReadOnly

Date the given survey was completed.
Role string ReadOnly

Individual's role.
FullName string ReadOnly

Individual's full name.
ProjectedEndDate date ReadOnly

Projected end date of the project.
EndDateChanges integer ReadOnly

Number of times the project end date changed.
Duration integer ReadOnly

Duration of the project.
TeamSponsor string ReadOnly

Name(s) of the team sponser(s).
TeamLeader string ReadOnly

Name(s) of the team leader(s).
TeamMember string ReadOnly

Names of the team members.
SampleDate date ReadOnly

Sample date for the survey.
Review boolean ReadOnly

Status of Review
Viewer string ReadOnly

Name of the person viewing the survey.
DateRequested date ReadOnly

Date the survey was requested.
CoachName string ReadOnly

Name of the Coach.
PlayerName string ReadOnly

Name of the player.
Status string ReadOnly

Status of the given survey.
StatusDate date ReadOnly

Date the given survey entered the current status.
TotalReviews integer ReadOnly

Total number of Reviews.
AllUsersOpen integer ReadOnly

Number of users the survey is open to.
CurrentUserOpen boolean ReadOnly

Open status of the current user.
FinalApproval boolean ReadOnly

Status of final approval for the given survey.
PlayerSRID integer ReadOnly

Player survey ID
CoachSRID integer ReadOnly

Coach Survey ID

Response Formats

application/xml, text/xml

Sample
<SurveyInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <AllUsersOpen>1</AllUsersOpen>
  <CoachName>sample string 10</CoachName>
  <CoachSRID>1</CoachSRID>
  <CurrentUserOpen>true</CurrentUserOpen>
  <DateCompleted>2024-10-24T11:59:40.9872335+00:00</DateCompleted>
  <DateRequested>2024-10-24T11:59:40.9872335+00:00</DateRequested>
  <DateRequired>2024-10-24T11:59:40.9872335+00:00</DateRequired>
  <Duration>1</Duration>
  <EndDate>2024-10-24T11:59:40.9872335+00:00</EndDate>
  <EndDateChanges>5</EndDateChanges>
  <FinalApproval>true</FinalApproval>
  <FullName>sample string 4</FullName>
  <ItemID>aa623240-d796-40af-b3b0-08f569536d4d</ItemID>
  <Name>sample string 2</Name>
  <PlayerName>sample string 11</PlayerName>
  <PlayerSRID>1</PlayerSRID>
  <ProjectedEndDate>2024-10-24T11:59:40.9872335+00:00</ProjectedEndDate>
  <Review>true</Review>
  <Role>sample string 3</Role>
  <SampleDate>2024-10-24T11:59:40.9872335+00:00</SampleDate>
  <StartDate>2024-10-24T11:59:40.9872335+00:00</StartDate>
  <Status>sample string 12</Status>
  <StatusDate>2024-10-24T11:59:40.9872335+00:00</StatusDate>
  <TeamLeader>sample string 7</TeamLeader>
  <TeamMember>sample string 8</TeamMember>
  <TeamSponsor>sample string 6</TeamSponsor>
  <TotalReviews>1</TotalReviews>
  <Viewer>sample string 9</Viewer>
</SurveyInfo>

application/json, text/json

Sample
{
  "ItemID": "aa623240-d796-40af-b3b0-08f569536d4d",
  "Name": "sample string 2",
  "StartDate": "2024-10-24T11:59:40.9872335+00:00",
  "EndDate": "2024-10-24T11:59:40.9872335+00:00",
  "DateRequired": "2024-10-24T11:59:40.9872335+00:00",
  "DateCompleted": "2024-10-24T11:59:40.9872335+00:00",
  "Role": "sample string 3",
  "FullName": "sample string 4",
  "ProjectedEndDate": "2024-10-24T11:59:40.9872335+00:00",
  "EndDateChanges": 5,
  "Duration": 1,
  "TeamSponsor": "sample string 6",
  "TeamLeader": "sample string 7",
  "TeamMember": "sample string 8",
  "SampleDate": "2024-10-24T11:59:40.9872335+00:00",
  "Review": true,
  "Viewer": "sample string 9",
  "DateRequested": "2024-10-24T11:59:40.9872335+00:00",
  "CoachName": "sample string 10",
  "PlayerName": "sample string 11",
  "Status": "sample string 12",
  "StatusDate": "2024-10-24T11:59:40.9872335+00:00",
  "TotalReviews": 1,
  "AllUsersOpen": 1,
  "CurrentUserOpen": true,
  "FinalApproval": true,
  "PlayerSRID": 1,
  "CoachSRID": 1
}