GET api/v{version}/laboratory/{laboratoryId}/survey/{surveyId}

Gets a list of Surveys belonging to the specified Laboratory.

Request Information

URI Parameters

Name	Type	Additional information
laboratoryId	integer	Required
surveyId	integer	Default value is -1
version	string	None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfIEnumerableOfSurveyListModel

Name	Description	Type	Additional information
Data		Collection of SurveyListModel	None.
StatusCode	Gets or sets the status code.	HttpStatusCode	None.
StatusDescription	Gets or sets the status description.	string	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "data": [
    {
      "surveyID": 1,
      "title": "sample string 2",
      "description": "sample string 3",
      "oneTime": true,
      "laboratoryID": 5,
      "allowReverseNavigation": true,
      "randomizeQuestionOrder": true,
      "randomizeAnswerOrder": true,
      "controlledNavigation": true,
      "privateNotes": "sample string 10",
      "closeAfterExpectedCompletionDate": true,
      "autoDistributeTimePeriodID": 12,
      "autoDistributeWeeklyDayID": 13,
      "autoDistributeMonthlyDayID": 14,
      "starterSurvey": true,
      "starterSurveyDistributionID": 16,
      "alertWhenScoreLessThan": 17,
      "disableCheckAnswer": true,
      "disableBackward": true,
      "sharedSurvey": true,
      "category": "sample string 21",
      "subCategory": "sample string 22",
      "hidden": true,
      "doNotCopyPriorRecipients": true,
      "assignToCurrentDistribution": true,
      "careTeamCanAnswer": true
    },
    {
      "surveyID": 1,
      "title": "sample string 2",
      "description": "sample string 3",
      "oneTime": true,
      "laboratoryID": 5,
      "allowReverseNavigation": true,
      "randomizeQuestionOrder": true,
      "randomizeAnswerOrder": true,
      "controlledNavigation": true,
      "privateNotes": "sample string 10",
      "closeAfterExpectedCompletionDate": true,
      "autoDistributeTimePeriodID": 12,
      "autoDistributeWeeklyDayID": 13,
      "autoDistributeMonthlyDayID": 14,
      "starterSurvey": true,
      "starterSurveyDistributionID": 16,
      "alertWhenScoreLessThan": 17,
      "disableCheckAnswer": true,
      "disableBackward": true,
      "sharedSurvey": true,
      "category": "sample string 21",
      "subCategory": "sample string 22",
      "hidden": true,
      "doNotCopyPriorRecipients": true,
      "assignToCurrentDistribution": true,
      "careTeamCanAnswer": true
    }
  ],
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfSurveyListModeluskxzdf5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
    <d2p1:SurveyListModel>
      <d2p1:AlertWhenScoreLessThan>17</d2p1:AlertWhenScoreLessThan>
      <d2p1:AllowReverseNavigation>true</d2p1:AllowReverseNavigation>
      <d2p1:AssignToCurrentDistribution>true</d2p1:AssignToCurrentDistribution>
      <d2p1:AutoDistributeMonthlyDayID>14</d2p1:AutoDistributeMonthlyDayID>
      <d2p1:AutoDistributeTimePeriodID>12</d2p1:AutoDistributeTimePeriodID>
      <d2p1:AutoDistributeWeeklyDayID>13</d2p1:AutoDistributeWeeklyDayID>
      <d2p1:CareTeamCanAnswer>true</d2p1:CareTeamCanAnswer>
      <d2p1:Category>sample string 21</d2p1:Category>
      <d2p1:CloseAfterExpectedCompletionDate>true</d2p1:CloseAfterExpectedCompletionDate>
      <d2p1:ControlledNavigation>true</d2p1:ControlledNavigation>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DisableBackward>true</d2p1:DisableBackward>
      <d2p1:DisableCheckAnswer>true</d2p1:DisableCheckAnswer>
      <d2p1:DoNotCopyPriorRecipients>true</d2p1:DoNotCopyPriorRecipients>
      <d2p1:Hidden>true</d2p1:Hidden>
      <d2p1:LaboratoryID>5</d2p1:LaboratoryID>
      <d2p1:OneTime>true</d2p1:OneTime>
      <d2p1:PrivateNotes>sample string 10</d2p1:PrivateNotes>
      <d2p1:RandomizeAnswerOrder>true</d2p1:RandomizeAnswerOrder>
      <d2p1:RandomizeQuestionOrder>true</d2p1:RandomizeQuestionOrder>
      <d2p1:SharedSurvey>true</d2p1:SharedSurvey>
      <d2p1:StarterSurvey>true</d2p1:StarterSurvey>
      <d2p1:StarterSurveyDistributionID>16</d2p1:StarterSurveyDistributionID>
      <d2p1:SubCategory>sample string 22</d2p1:SubCategory>
      <d2p1:SurveyID>1</d2p1:SurveyID>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:SurveyListModel>
    <d2p1:SurveyListModel>
      <d2p1:AlertWhenScoreLessThan>17</d2p1:AlertWhenScoreLessThan>
      <d2p1:AllowReverseNavigation>true</d2p1:AllowReverseNavigation>
      <d2p1:AssignToCurrentDistribution>true</d2p1:AssignToCurrentDistribution>
      <d2p1:AutoDistributeMonthlyDayID>14</d2p1:AutoDistributeMonthlyDayID>
      <d2p1:AutoDistributeTimePeriodID>12</d2p1:AutoDistributeTimePeriodID>
      <d2p1:AutoDistributeWeeklyDayID>13</d2p1:AutoDistributeWeeklyDayID>
      <d2p1:CareTeamCanAnswer>true</d2p1:CareTeamCanAnswer>
      <d2p1:Category>sample string 21</d2p1:Category>
      <d2p1:CloseAfterExpectedCompletionDate>true</d2p1:CloseAfterExpectedCompletionDate>
      <d2p1:ControlledNavigation>true</d2p1:ControlledNavigation>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DisableBackward>true</d2p1:DisableBackward>
      <d2p1:DisableCheckAnswer>true</d2p1:DisableCheckAnswer>
      <d2p1:DoNotCopyPriorRecipients>true</d2p1:DoNotCopyPriorRecipients>
      <d2p1:Hidden>true</d2p1:Hidden>
      <d2p1:LaboratoryID>5</d2p1:LaboratoryID>
      <d2p1:OneTime>true</d2p1:OneTime>
      <d2p1:PrivateNotes>sample string 10</d2p1:PrivateNotes>
      <d2p1:RandomizeAnswerOrder>true</d2p1:RandomizeAnswerOrder>
      <d2p1:RandomizeQuestionOrder>true</d2p1:RandomizeQuestionOrder>
      <d2p1:SharedSurvey>true</d2p1:SharedSurvey>
      <d2p1:StarterSurvey>true</d2p1:StarterSurvey>
      <d2p1:StarterSurveyDistributionID>16</d2p1:StarterSurveyDistributionID>
      <d2p1:SubCategory>sample string 22</d2p1:SubCategory>
      <d2p1:SurveyID>1</d2p1:SurveyID>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:SurveyListModel>
  </Data>
</ResponseOfArrayOfSurveyListModeluskxzdf5>