POST api/healthsight/project

Request Information

URI Parameters

None.

Body Parameters

SSProjectRequest
NameDescriptionTypeAdditional information
clientId

string

None.

userId

string

None.

project

SSProject

None.

projectsample

SSProjectsample

None.

qualification

Collection of SSQualification

None.

quota

Collection of SSQuota

None.

panel

Collection of SSPanel

None.

filter

SSFilter

None.

Request Formats

application/json, text/json

Sample:
{
  "clientId": "sample string 1",
  "userId": "sample string 2",
  "project": {
    "projectName": "sample string 1",
    "marketId": 2,
    "surveyLength": 3,
    "totalCompletesNeeded": 4,
    "totalProjectCost": 5.1,
    "surveyTopic": "sample string 6",
    "surveyUrl": "sample string 7",
    "actualSurveyLength": 8,
    "projectGroupID": 9,
    "incedentRates": 10,
    "startDate": "2025-01-21T23:22:52.0232399-05:00",
    "endDate": "2025-01-21T23:22:52.0232399-05:00",
    "accountEntityId": 11
  },
  "projectsample": {
    "panelId": 1,
    "sampleName": "sample string 2",
    "sampleSize": 3,
    "numberNeeded": 4
  },
  "qualification": [
    {
      "type": "sample string 1",
      "fieldName": "sample string 2",
      "logicalOperator": "sample string 3",
      "valueList": "sample string 4"
    },
    {
      "type": "sample string 1",
      "fieldName": "sample string 2",
      "logicalOperator": "sample string 3",
      "valueList": "sample string 4"
    }
  ],
  "quota": [
    {
      "type": "sample string 1",
      "quotapercent": 2.1,
      "completes": 3,
      "fieldName": "sample string 4",
      "logicalOperator": "sample string 5",
      "valueList": "sample string 6"
    },
    {
      "type": "sample string 1",
      "quotapercent": 2.1,
      "completes": 3,
      "fieldName": "sample string 4",
      "logicalOperator": "sample string 5",
      "valueList": "sample string 6"
    }
  ],
  "panel": [
    {
      "panelistId": 1,
      "uniqueId": "sample string 2"
    },
    {
      "panelistId": 1,
      "uniqueId": "sample string 2"
    }
  ],
  "filter": {
    "continentIds": "sample string 1",
    "countryIds": "sample string 2",
    "stateIds": "sample string 3",
    "cityIds": "sample string 4",
    "specialityIds": "sample string 5",
    "subSpecialityIds": "sample string 6",
    "experienceFrom": 7.1,
    "experienceTo": 8.1,
    "ageFrom": 9.1,
    "ageTo": 10.1,
    "malePatientAgeFrom": 11.1,
    "malePatientAgeTo": 12.1,
    "femalePatientAgeFrom": 13.1,
    "femalePatientAgeTo": 14.1,
    "childrenPatientAgeFrom": 15.1,
    "childrenPatientAgeTo": 16.1,
    "allPatient": true,
    "malePatient": true,
    "femalePatient": true,
    "childrenPatient": true,
    "allPatientAgeFrom": 21.1,
    "allPatientAgeTo": 22.1,
    "medicalConditionIds": "sample string 23",
    "drugIds": "sample string 24"
  }
}

text/xml

Sample:
<SSProjectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PMSBL.Entity">
  <clientId>sample string 1</clientId>
  <filter>
    <AgeFrom>9.1</AgeFrom>
    <AgeTo>10.1</AgeTo>
    <AllPatient>true</AllPatient>
    <AllPatientAgeFrom>21.1</AllPatientAgeFrom>
    <AllPatientAgeTo>22.1</AllPatientAgeTo>
    <ChildrenPatient>true</ChildrenPatient>
    <ChildrenPatientAgeFrom>15.1</ChildrenPatientAgeFrom>
    <ChildrenPatientAgeTo>16.1</ChildrenPatientAgeTo>
    <CityIds>sample string 4</CityIds>
    <ContinentIds>sample string 1</ContinentIds>
    <CountryIds>sample string 2</CountryIds>
    <DrugIds>sample string 24</DrugIds>
    <ExperienceFrom>7.1</ExperienceFrom>
    <ExperienceTo>8.1</ExperienceTo>
    <FemalePatient>true</FemalePatient>
    <FemalePatientAgeFrom>13.1</FemalePatientAgeFrom>
    <FemalePatientAgeTo>14.1</FemalePatientAgeTo>
    <MalePatient>true</MalePatient>
    <MalePatientAgeFrom>11.1</MalePatientAgeFrom>
    <MalePatientAgeTo>12.1</MalePatientAgeTo>
    <MedicalConditionIds>sample string 23</MedicalConditionIds>
    <SpecialityIds>sample string 5</SpecialityIds>
    <StateIds>sample string 3</StateIds>
    <SubSpecialityIds>sample string 6</SubSpecialityIds>
  </filter>
  <panel>
    <SSPanel>
      <PanelistId>1</PanelistId>
      <UniqueId>sample string 2</UniqueId>
    </SSPanel>
    <SSPanel>
      <PanelistId>1</PanelistId>
      <UniqueId>sample string 2</UniqueId>
    </SSPanel>
  </panel>
  <project>
    <AccountEntityId>11</AccountEntityId>
    <ActualSurveyLength>8</ActualSurveyLength>
    <EndDate>2025-01-21T23:22:52.0232399-05:00</EndDate>
    <IncedentRates>10</IncedentRates>
    <MarketId>2</MarketId>
    <ProjectGroupID>9</ProjectGroupID>
    <ProjectName>sample string 1</ProjectName>
    <StartDate>2025-01-21T23:22:52.0232399-05:00</StartDate>
    <SurveyLength>3</SurveyLength>
    <SurveyTopic>sample string 6</SurveyTopic>
    <SurveyUrl>sample string 7</SurveyUrl>
    <TotalCompletesNeeded>4</TotalCompletesNeeded>
    <TotalProjectCost>5.1</TotalProjectCost>
  </project>
  <projectsample>
    <NumberNeeded>4</NumberNeeded>
    <PanelId>1</PanelId>
    <SampleName>sample string 2</SampleName>
    <SampleSize>3</SampleSize>
  </projectsample>
  <qualification>
    <SSQualification>
      <FieldName>sample string 2</FieldName>
      <LogicalOperator>sample string 3</LogicalOperator>
      <Type>sample string 1</Type>
      <ValueList>sample string 4</ValueList>
    </SSQualification>
    <SSQualification>
      <FieldName>sample string 2</FieldName>
      <LogicalOperator>sample string 3</LogicalOperator>
      <Type>sample string 1</Type>
      <ValueList>sample string 4</ValueList>
    </SSQualification>
  </qualification>
  <quota>
    <SSQuota>
      <Completes>3</Completes>
      <FieldName>sample string 4</FieldName>
      <LogicalOperator>sample string 5</LogicalOperator>
      <Quotapercent>2.1</Quotapercent>
      <Type>sample string 1</Type>
      <ValueList>sample string 6</ValueList>
    </SSQuota>
    <SSQuota>
      <Completes>3</Completes>
      <FieldName>sample string 4</FieldName>
      <LogicalOperator>sample string 5</LogicalOperator>
      <Quotapercent>2.1</Quotapercent>
      <Type>sample string 1</Type>
      <ValueList>sample string 6</ValueList>
    </SSQuota>
  </quota>
  <userId>sample string 2</userId>
</SSProjectRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.