POST api/TakeAssessment

Request Information

URI Parameters

None.

Body Parameters

ShortTakeAssessment
NameDescriptionTypeAdditional information
id

integer

None.

assessment

AssessmentDetail

None.

assessmentId

integer

None.

siteId

integer

None.

site

ShortSite

None.

isPreAssessment

boolean

None.

created

date

None.

updated

date

None.

results

Collection of ShortAssessmentResults

None.

scoreOptions

Collection of ShortScore

None.

notes

Collection of ShortResultNotes

None.

whoTaking

string

None.

guid

string

None.

isComplete

boolean

None.

setNames

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "assessment": {
    "id": 1,
    "name": "sample string 2",
    "isFinal": true,
    "content": [
      {
        "setId": 1,
        "setName": "sample string 2",
        "setOrder": 3,
        "categories": [
          {
            "categoryId": 1,
            "categoryName": "sample string 2",
            "categoryOrder": 3,
            "standards": [
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              },
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              }
            ]
          },
          {
            "categoryId": 1,
            "categoryName": "sample string 2",
            "categoryOrder": 3,
            "standards": [
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              },
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              }
            ]
          }
        ],
        "logo": "sample string 4",
        "color": "sample string 5"
      },
      {
        "setId": 1,
        "setName": "sample string 2",
        "setOrder": 3,
        "categories": [
          {
            "categoryId": 1,
            "categoryName": "sample string 2",
            "categoryOrder": 3,
            "standards": [
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              },
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              }
            ]
          },
          {
            "categoryId": 1,
            "categoryName": "sample string 2",
            "categoryOrder": 3,
            "standards": [
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              },
              {
                "standardId": 1,
                "standardName": "sample string 2",
                "standardOrder": 3,
                "indicators": [
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  },
                  {
                    "id": 1,
                    "text": "sample string 2",
                    "evidence": "sample string 3",
                    "standardId": 4,
                    "displayOrder": 5
                  }
                ],
                "isRequired": true
              }
            ]
          }
        ],
        "logo": "sample string 4",
        "color": "sample string 5"
      }
    ],
    "description": "sample string 4",
    "image": "sample string 5"
  },
  "assessmentId": 2,
  "siteId": 3,
  "site": {
    "name": "sample string 1",
    "id": 2,
    "organizationName": "sample string 3",
    "organizationId": 4,
    "iconClass": "sample string 5",
    "address1": "sample string 6",
    "address2": "sample string 7",
    "city": "sample string 8",
    "zip": "sample string 9",
    "stateId": 10,
    "stateName": "sample string 11",
    "phone": "sample string 12",
    "orgTypeId": 13,
    "orgTypeName": "sample string 14",
    "siteAdmin": "sample string 15",
    "siteAdminEmail": "sample string 16",
    "siteAdminId": 1,
    "isActive": true,
    "canCreateAssessments": true,
    "counties": "sample string 19",
    "schoolDurationId": 1,
    "schoolDurationName": "sample string 20",
    "cycText": "sample string 21",
    "totalServedLastYear": "sample string 22",
    "totalServedLastSummer": "sample string 23",
    "average30days": "sample string 24",
    "otherNeed": "sample string 25",
    "grades": [
      {
        "name": "sample string 1",
        "id": 2,
        "isActive": true
      },
      {
        "name": "sample string 1",
        "id": 2,
        "isActive": true
      }
    ],
    "activities": [
      {
        "name": "sample string 1",
        "id": 2,
        "isActive": true
      },
      {
        "name": "sample string 1",
        "id": 2,
        "isActive": true
      }
    ],
    "specialDesignations": [
      {
        "name": "sample string 1",
        "id": 2,
        "isActive": true
      },
      {
        "name": "sample string 1",
        "id": 2,
        "isActive": true
      }
    ],
    "needsUpdate": true,
    "salesforceId": "sample string 27"
  },
  "isPreAssessment": true,
  "created": "2019-09-09T12:15:18.7865306+00:00",
  "updated": "2019-09-09T12:15:18.7865306+00:00",
  "results": [
    {
      "id": 1,
      "takingId": 2,
      "indicatorId": 3,
      "standardId": 4,
      "categoryId": 5,
      "setId": 6,
      "scoringId": 7,
      "takingGuid": "sample string 8"
    },
    {
      "id": 1,
      "takingId": 2,
      "indicatorId": 3,
      "standardId": 4,
      "categoryId": 5,
      "setId": 6,
      "scoringId": 7,
      "takingGuid": "sample string 8"
    }
  ],
  "scoreOptions": [
    {
      "id": 1,
      "assessmentId": 1,
      "scoreDescription": "sample string 2",
      "scoreValue": 3,
      "meetsThreshold": true
    },
    {
      "id": 1,
      "assessmentId": 1,
      "scoreDescription": "sample string 2",
      "scoreValue": 3,
      "meetsThreshold": true
    }
  ],
  "notes": [
    {
      "id": 1,
      "note": "sample string 2",
      "standardId": 3,
      "takingId": 4,
      "takingGuid": "sample string 5"
    },
    {
      "id": 1,
      "note": "sample string 2",
      "standardId": 3,
      "takingId": 4,
      "takingGuid": "sample string 5"
    }
  ],
  "whoTaking": "sample string 7",
  "guid": "sample string 8",
  "isComplete": true,
  "setNames": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ShortTakeAssessment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IAN_QPSA.Models">
  <assessment>
    <content>
      <AssessmentSet>
        <categories>
          <AssessmentCategory>
            <categoryId>1</categoryId>
            <categoryName>sample string 2</categoryName>
            <categoryOrder>3</categoryOrder>
            <standards>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
            </standards>
          </AssessmentCategory>
          <AssessmentCategory>
            <categoryId>1</categoryId>
            <categoryName>sample string 2</categoryName>
            <categoryOrder>3</categoryOrder>
            <standards>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
            </standards>
          </AssessmentCategory>
        </categories>
        <color>sample string 5</color>
        <logo>sample string 4</logo>
        <setId>1</setId>
        <setName>sample string 2</setName>
        <setOrder>3</setOrder>
      </AssessmentSet>
      <AssessmentSet>
        <categories>
          <AssessmentCategory>
            <categoryId>1</categoryId>
            <categoryName>sample string 2</categoryName>
            <categoryOrder>3</categoryOrder>
            <standards>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
            </standards>
          </AssessmentCategory>
          <AssessmentCategory>
            <categoryId>1</categoryId>
            <categoryName>sample string 2</categoryName>
            <categoryOrder>3</categoryOrder>
            <standards>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
              <AssessmentStandard>
                <indicators>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                  <ShortIndicator>
                    <displayOrder>5</displayOrder>
                    <evidence>sample string 3</evidence>
                    <id>1</id>
                    <standardId>4</standardId>
                    <text>sample string 2</text>
                  </ShortIndicator>
                </indicators>
                <isRequired>true</isRequired>
                <standardId>1</standardId>
                <standardName>sample string 2</standardName>
                <standardOrder>3</standardOrder>
              </AssessmentStandard>
            </standards>
          </AssessmentCategory>
        </categories>
        <color>sample string 5</color>
        <logo>sample string 4</logo>
        <setId>1</setId>
        <setName>sample string 2</setName>
        <setOrder>3</setOrder>
      </AssessmentSet>
    </content>
    <description>sample string 4</description>
    <id>1</id>
    <image>sample string 5</image>
    <isFinal>true</isFinal>
    <name>sample string 2</name>
  </assessment>
  <assessmentId>2</assessmentId>
  <created>2019-09-09T12:15:18.7865306+00:00</created>
  <guid>sample string 8</guid>
  <id>1</id>
  <isComplete>true</isComplete>
  <isPreAssessment>true</isPreAssessment>
  <notes>
    <ShortResultNotes>
      <id>1</id>
      <note>sample string 2</note>
      <standardId>3</standardId>
      <takingGuid>sample string 5</takingGuid>
      <takingId>4</takingId>
    </ShortResultNotes>
    <ShortResultNotes>
      <id>1</id>
      <note>sample string 2</note>
      <standardId>3</standardId>
      <takingGuid>sample string 5</takingGuid>
      <takingId>4</takingId>
    </ShortResultNotes>
  </notes>
  <results>
    <ShortAssessmentResults>
      <categoryId>5</categoryId>
      <id>1</id>
      <indicatorId>3</indicatorId>
      <scoringId>7</scoringId>
      <setId>6</setId>
      <standardId>4</standardId>
      <takingGuid>sample string 8</takingGuid>
      <takingId>2</takingId>
    </ShortAssessmentResults>
    <ShortAssessmentResults>
      <categoryId>5</categoryId>
      <id>1</id>
      <indicatorId>3</indicatorId>
      <scoringId>7</scoringId>
      <setId>6</setId>
      <standardId>4</standardId>
      <takingGuid>sample string 8</takingGuid>
      <takingId>2</takingId>
    </ShortAssessmentResults>
  </results>
  <scoreOptions>
    <ShortScore>
      <assessmentId>1</assessmentId>
      <id>1</id>
      <meetsThreshold>true</meetsThreshold>
      <scoreDescription>sample string 2</scoreDescription>
      <scoreValue>3</scoreValue>
    </ShortScore>
    <ShortScore>
      <assessmentId>1</assessmentId>
      <id>1</id>
      <meetsThreshold>true</meetsThreshold>
      <scoreDescription>sample string 2</scoreDescription>
      <scoreValue>3</scoreValue>
    </ShortScore>
  </scoreOptions>
  <setNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </setNames>
  <site>
    <activities>
      <DropdownItem>
        <id>2</id>
        <isActive>true</isActive>
        <name>sample string 1</name>
      </DropdownItem>
      <DropdownItem>
        <id>2</id>
        <isActive>true</isActive>
        <name>sample string 1</name>
      </DropdownItem>
    </activities>
    <address1>sample string 6</address1>
    <address2>sample string 7</address2>
    <average30days>sample string 24</average30days>
    <canCreateAssessments>true</canCreateAssessments>
    <city>sample string 8</city>
    <counties>sample string 19</counties>
    <cycText>sample string 21</cycText>
    <grades>
      <DropdownItem>
        <id>2</id>
        <isActive>true</isActive>
        <name>sample string 1</name>
      </DropdownItem>
      <DropdownItem>
        <id>2</id>
        <isActive>true</isActive>
        <name>sample string 1</name>
      </DropdownItem>
    </grades>
    <iconClass>sample string 5</iconClass>
    <id>2</id>
    <isActive>true</isActive>
    <name>sample string 1</name>
    <needsUpdate>true</needsUpdate>
    <orgTypeId>13</orgTypeId>
    <orgTypeName>sample string 14</orgTypeName>
    <organizationId>4</organizationId>
    <organizationName>sample string 3</organizationName>
    <otherNeed>sample string 25</otherNeed>
    <phone>sample string 12</phone>
    <salesforceId>sample string 27</salesforceId>
    <schoolDurationId>1</schoolDurationId>
    <schoolDurationName>sample string 20</schoolDurationName>
    <siteAdmin>sample string 15</siteAdmin>
    <siteAdminEmail>sample string 16</siteAdminEmail>
    <siteAdminId>1</siteAdminId>
    <specialDesignations>
      <DropdownItem>
        <id>2</id>
        <isActive>true</isActive>
        <name>sample string 1</name>
      </DropdownItem>
      <DropdownItem>
        <id>2</id>
        <isActive>true</isActive>
        <name>sample string 1</name>
      </DropdownItem>
    </specialDesignations>
    <stateId>10</stateId>
    <stateName>sample string 11</stateName>
    <totalServedLastSummer>sample string 23</totalServedLastSummer>
    <totalServedLastYear>sample string 22</totalServedLastYear>
    <zip>sample string 9</zip>
  </site>
  <siteId>3</siteId>
  <updated>2019-09-09T12:15:18.7865306+00:00</updated>
  <whoTaking>sample string 7</whoTaking>
</ShortTakeAssessment>

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.