POST api/Forms

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
formId	integer	None.
refFormTypeId	integer	None.
refUnitTypeId	integer	None.
areaId	integer	None.
formCode	string	None.
formName	string	None.
startDate	date	None.
formStatus	string	None.
description	string	None.
isActive	boolean	None.
sections	Collection of FormSectionDTO	None.
listFormId	Collection of integer	None.
userRequestId	integer	None.
userRoleId	integer	None.
userOfficeId	integer	None.
timestamp	Collection of byte	None.

Request Formats

application/json, text/json

Sample:

{
  "formId": 1,
  "refFormTypeId": 2,
  "refUnitTypeId": 3,
  "areaId": 4,
  "formCode": "sample string 5",
  "formName": "sample string 6",
  "startDate": "2026-09-17T14:42:08.8029355+00:00",
  "formStatus": "sample string 8",
  "description": "sample string 9",
  "isActive": true,
  "sections": [
    {
      "formId": 1,
      "formSectionId": 2,
      "formSectionCode": "sample string 3",
      "formSectionName": "sample string 4",
      "formSectionWeight": 5.1,
      "formSectionIcon": "sample string 6",
      "isPublic": true,
      "isActive": true,
      "order": 9,
      "details": [
        {
          "formDetailId": 1,
          "formSectionId": 2,
          "refPhysicalImageCaptionId": 1,
          "refFormAnswerTypeId": 3,
          "typeLegalDocCode": "sample string 4",
          "code": "sample string 5",
          "question": "sample string 6",
          "specCode": "sample string 7",
          "weight": 8.1,
          "isActive": true,
          "order": 10,
          "options": [
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            },
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            }
          ],
          "userRequestId": 11,
          "userRoleId": 12,
          "userOfficeId": 13,
          "timestamp": "QEA="
        },
        {
          "formDetailId": 1,
          "formSectionId": 2,
          "refPhysicalImageCaptionId": 1,
          "refFormAnswerTypeId": 3,
          "typeLegalDocCode": "sample string 4",
          "code": "sample string 5",
          "question": "sample string 6",
          "specCode": "sample string 7",
          "weight": 8.1,
          "isActive": true,
          "order": 10,
          "options": [
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            },
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            }
          ],
          "userRequestId": 11,
          "userRoleId": 12,
          "userOfficeId": 13,
          "timestamp": "QEA="
        }
      ],
      "userRequestId": 10,
      "userRoleId": 11,
      "userOfficeId": 12,
      "timestamp": "QEA="
    },
    {
      "formId": 1,
      "formSectionId": 2,
      "formSectionCode": "sample string 3",
      "formSectionName": "sample string 4",
      "formSectionWeight": 5.1,
      "formSectionIcon": "sample string 6",
      "isPublic": true,
      "isActive": true,
      "order": 9,
      "details": [
        {
          "formDetailId": 1,
          "formSectionId": 2,
          "refPhysicalImageCaptionId": 1,
          "refFormAnswerTypeId": 3,
          "typeLegalDocCode": "sample string 4",
          "code": "sample string 5",
          "question": "sample string 6",
          "specCode": "sample string 7",
          "weight": 8.1,
          "isActive": true,
          "order": 10,
          "options": [
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            },
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            }
          ],
          "userRequestId": 11,
          "userRoleId": 12,
          "userOfficeId": 13,
          "timestamp": "QEA="
        },
        {
          "formDetailId": 1,
          "formSectionId": 2,
          "refPhysicalImageCaptionId": 1,
          "refFormAnswerTypeId": 3,
          "typeLegalDocCode": "sample string 4",
          "code": "sample string 5",
          "question": "sample string 6",
          "specCode": "sample string 7",
          "weight": 8.1,
          "isActive": true,
          "order": 10,
          "options": [
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            },
            {
              "formDetailOptionId": 1,
              "formDetailId": 2,
              "optionAnswer": "sample string 3",
              "answerScore": 4.1,
              "componentPricePercentage": 5.1
            }
          ],
          "userRequestId": 11,
          "userRoleId": 12,
          "userOfficeId": 13,
          "timestamp": "QEA="
        }
      ],
      "userRequestId": 10,
      "userRoleId": 11,
      "userOfficeId": 12,
      "timestamp": "QEA="
    }
  ],
  "listFormId": [
    1,
    2
  ],
  "userRequestId": 11,
  "userRoleId": 12,
  "userOfficeId": 13,
  "timestamp": "QEA="
}

text/html

Sample:

{"formId":1,"refFormTypeId":2,"refUnitTypeId":3,"areaId":4,"formCode":"sample string 5","formName":"sample string 6","startDate":"2026-09-17T14:42:08.8029355+00:00","formStatus":"sample string 8","description":"sample string 9","isActive":true,"sections":[{"formId":1,"formSectionId":2,"formSectionCode":"sample string 3","formSectionName":"sample string 4","formSectionWeight":5.1,"formSectionIcon":"sample string 6","isPublic":true,"isActive":true,"order":9,"details":[{"formDetailId":1,"formSectionId":2,"refPhysicalImageCaptionId":1,"refFormAnswerTypeId":3,"typeLegalDocCode":"sample string 4","code":"sample string 5","question":"sample string 6","specCode":"sample string 7","weight":8.1,"isActive":true,"order":10,"options":[{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1},{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1}],"userRequestId":11,"userRoleId":12,"userOfficeId":13,"timestamp":"QEA="},{"formDetailId":1,"formSectionId":2,"refPhysicalImageCaptionId":1,"refFormAnswerTypeId":3,"typeLegalDocCode":"sample string 4","code":"sample string 5","question":"sample string 6","specCode":"sample string 7","weight":8.1,"isActive":true,"order":10,"options":[{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1},{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1}],"userRequestId":11,"userRoleId":12,"userOfficeId":13,"timestamp":"QEA="}],"userRequestId":10,"userRoleId":11,"userOfficeId":12,"timestamp":"QEA="},{"formId":1,"formSectionId":2,"formSectionCode":"sample string 3","formSectionName":"sample string 4","formSectionWeight":5.1,"formSectionIcon":"sample string 6","isPublic":true,"isActive":true,"order":9,"details":[{"formDetailId":1,"formSectionId":2,"refPhysicalImageCaptionId":1,"refFormAnswerTypeId":3,"typeLegalDocCode":"sample string 4","code":"sample string 5","question":"sample string 6","specCode":"sample string 7","weight":8.1,"isActive":true,"order":10,"options":[{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1},{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1}],"userRequestId":11,"userRoleId":12,"userOfficeId":13,"timestamp":"QEA="},{"formDetailId":1,"formSectionId":2,"refPhysicalImageCaptionId":1,"refFormAnswerTypeId":3,"typeLegalDocCode":"sample string 4","code":"sample string 5","question":"sample string 6","specCode":"sample string 7","weight":8.1,"isActive":true,"order":10,"options":[{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1},{"formDetailOptionId":1,"formDetailId":2,"optionAnswer":"sample string 3","answerScore":4.1,"componentPricePercentage":5.1}],"userRequestId":11,"userRoleId":12,"userOfficeId":13,"timestamp":"QEA="}],"userRequestId":10,"userRoleId":11,"userOfficeId":12,"timestamp":"QEA="}],"listFormId":[1,2],"userRequestId":11,"userRoleId":12,"userOfficeId":13,"timestamp":"QEA="}

application/xml, text/xml

Sample:

<FormDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models.Form">
  <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
  <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">13</userOfficeId>
  <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRequestId>
  <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userRoleId>
  <areaId>4</areaId>
  <description>sample string 9</description>
  <formCode>sample string 5</formCode>
  <formId>1</formId>
  <formName>sample string 6</formName>
  <formStatus>sample string 8</formStatus>
  <isActive>true</isActive>
  <listFormId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </listFormId>
  <refFormTypeId>2</refFormTypeId>
  <sections>
    <FormSectionDTO>
      <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
      <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userOfficeId>
      <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">10</userRequestId>
      <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRoleId>
      <details>
        <FormDetailDTO>
          <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
          <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">13</userOfficeId>
          <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRequestId>
          <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userRoleId>
          <code>sample string 5</code>
          <formDetailId>1</formDetailId>
          <formSectionId>2</formSectionId>
          <isActive>true</isActive>
          <options>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
          </options>
          <order>10</order>
          <question>sample string 6</question>
          <refFormAnswerTypeId>3</refFormAnswerTypeId>
          <refPhysicalImageCaptionId>1</refPhysicalImageCaptionId>
          <specCode>sample string 7</specCode>
          <typeLegalDocCode>sample string 4</typeLegalDocCode>
          <weight>8.1</weight>
        </FormDetailDTO>
        <FormDetailDTO>
          <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
          <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">13</userOfficeId>
          <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRequestId>
          <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userRoleId>
          <code>sample string 5</code>
          <formDetailId>1</formDetailId>
          <formSectionId>2</formSectionId>
          <isActive>true</isActive>
          <options>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
          </options>
          <order>10</order>
          <question>sample string 6</question>
          <refFormAnswerTypeId>3</refFormAnswerTypeId>
          <refPhysicalImageCaptionId>1</refPhysicalImageCaptionId>
          <specCode>sample string 7</specCode>
          <typeLegalDocCode>sample string 4</typeLegalDocCode>
          <weight>8.1</weight>
        </FormDetailDTO>
      </details>
      <formId>1</formId>
      <formSectionCode>sample string 3</formSectionCode>
      <formSectionIcon>sample string 6</formSectionIcon>
      <formSectionId>2</formSectionId>
      <formSectionName>sample string 4</formSectionName>
      <formSectionWeight>5.1</formSectionWeight>
      <isActive>true</isActive>
      <isPublic>true</isPublic>
    </FormSectionDTO>
    <FormSectionDTO>
      <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
      <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userOfficeId>
      <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">10</userRequestId>
      <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRoleId>
      <details>
        <FormDetailDTO>
          <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
          <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">13</userOfficeId>
          <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRequestId>
          <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userRoleId>
          <code>sample string 5</code>
          <formDetailId>1</formDetailId>
          <formSectionId>2</formSectionId>
          <isActive>true</isActive>
          <options>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
          </options>
          <order>10</order>
          <question>sample string 6</question>
          <refFormAnswerTypeId>3</refFormAnswerTypeId>
          <refPhysicalImageCaptionId>1</refPhysicalImageCaptionId>
          <specCode>sample string 7</specCode>
          <typeLegalDocCode>sample string 4</typeLegalDocCode>
          <weight>8.1</weight>
        </FormDetailDTO>
        <FormDetailDTO>
          <timestamp xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">QEA=</timestamp>
          <userOfficeId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">13</userOfficeId>
          <userRequestId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">11</userRequestId>
          <userRoleId xmlns="http://schemas.datacontract.org/2004/07/Application.WebAPI.Models">12</userRoleId>
          <code>sample string 5</code>
          <formDetailId>1</formDetailId>
          <formSectionId>2</formSectionId>
          <isActive>true</isActive>
          <options>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
            <FormDetailOptionDTO>
              <answerScore>4.1</answerScore>
              <componentPricePercentage>5.1</componentPricePercentage>
              <formDetailId>2</formDetailId>
              <formDetailOptionId>1</formDetailOptionId>
              <optionAnswer>sample string 3</optionAnswer>
            </FormDetailOptionDTO>
          </options>
          <order>10</order>
          <question>sample string 6</question>
          <refFormAnswerTypeId>3</refFormAnswerTypeId>
          <refPhysicalImageCaptionId>1</refPhysicalImageCaptionId>
          <specCode>sample string 7</specCode>
          <typeLegalDocCode>sample string 4</typeLegalDocCode>
          <weight>8.1</weight>
        </FormDetailDTO>
      </details>
      <formId>1</formId>
      <formSectionCode>sample string 3</formSectionCode>
      <formSectionIcon>sample string 6</formSectionIcon>
      <formSectionId>2</formSectionId>
      <formSectionName>sample string 4</formSectionName>
      <formSectionWeight>5.1</formSectionWeight>
      <isActive>true</isActive>
      <isPublic>true</isPublic>
    </FormSectionDTO>
  </sections>
  <startDate>2026-09-17T14:42:08.8029355+00:00</startDate>
</FormDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />