PUT api/FormWiseControlDocumentations?MID={MID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
MID

integer

Required

Body Parameters

FormWiseControlDocumentations
NameDescriptionTypeAdditional information
MID

integer

None.

FORM_NAME

string

None.

CONTROL_NAME

string

None.

CONTROL_TYPE

string

None.

TABLE_NAME

string

None.

FIELD_NAME

string

None.

DATA_TYPE

string

None.

MAX_LENGTH

integer

None.

PARAMETER_COMPANY

string

None.

PARAMETER_BRANCH

string

None.

PARAMETER_USER

string

None.

PARAMETER_VOUCHER

string

None.

VALIDATION_1

string

None.

VALIDATION_1_MESSAGE

string

None.

VALIDATION_2

string

None.

VALIDATION_2_MESSAGE

string

None.

VALIDATION_3

string

None.

VALIDATION_3_MESSAGE

string

None.

VALIDATION_4

string

None.

VALIDATION_4_MESSAGE

string

None.

VALIDATION_5

string

None.

VALIDATION_5_MESSAGE

string

None.

TEST_DATA

string

None.

REMARKS

string

None.

MASK

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MID": 1,
  "FORM_NAME": "sample string 2",
  "CONTROL_NAME": "sample string 3",
  "CONTROL_TYPE": "sample string 4",
  "TABLE_NAME": "sample string 5",
  "FIELD_NAME": "sample string 6",
  "DATA_TYPE": "sample string 7",
  "MAX_LENGTH": 8,
  "PARAMETER_COMPANY": "sample string 9",
  "PARAMETER_BRANCH": "sample string 10",
  "PARAMETER_USER": "sample string 11",
  "PARAMETER_VOUCHER": "sample string 12",
  "VALIDATION_1": "sample string 13",
  "VALIDATION_1_MESSAGE": "sample string 14",
  "VALIDATION_2": "sample string 15",
  "VALIDATION_2_MESSAGE": "sample string 16",
  "VALIDATION_3": "sample string 17",
  "VALIDATION_3_MESSAGE": "sample string 18",
  "VALIDATION_4": "sample string 19",
  "VALIDATION_4_MESSAGE": "sample string 20",
  "VALIDATION_5": "sample string 21",
  "VALIDATION_5_MESSAGE": "sample string 22",
  "TEST_DATA": "sample string 23",
  "REMARKS": "sample string 24",
  "MASK": "sample string 25"
}

text/html

Sample:
{"MID":1,"FORM_NAME":"sample string 2","CONTROL_NAME":"sample string 3","CONTROL_TYPE":"sample string 4","TABLE_NAME":"sample string 5","FIELD_NAME":"sample string 6","DATA_TYPE":"sample string 7","MAX_LENGTH":8,"PARAMETER_COMPANY":"sample string 9","PARAMETER_BRANCH":"sample string 10","PARAMETER_USER":"sample string 11","PARAMETER_VOUCHER":"sample string 12","VALIDATION_1":"sample string 13","VALIDATION_1_MESSAGE":"sample string 14","VALIDATION_2":"sample string 15","VALIDATION_2_MESSAGE":"sample string 16","VALIDATION_3":"sample string 17","VALIDATION_3_MESSAGE":"sample string 18","VALIDATION_4":"sample string 19","VALIDATION_4_MESSAGE":"sample string 20","VALIDATION_5":"sample string 21","VALIDATION_5_MESSAGE":"sample string 22","TEST_DATA":"sample string 23","REMARKS":"sample string 24","MASK":"sample string 25"}

application/xml, text/xml

Sample:
<FormWiseControlDocumentations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SuntechSupportServices.Models.Documentation">
  <CONTROL_NAME>sample string 3</CONTROL_NAME>
  <CONTROL_TYPE>sample string 4</CONTROL_TYPE>
  <DATA_TYPE>sample string 7</DATA_TYPE>
  <FIELD_NAME>sample string 6</FIELD_NAME>
  <FORM_NAME>sample string 2</FORM_NAME>
  <MASK>sample string 25</MASK>
  <MAX_LENGTH>8</MAX_LENGTH>
  <MID>1</MID>
  <PARAMETER_BRANCH>sample string 10</PARAMETER_BRANCH>
  <PARAMETER_COMPANY>sample string 9</PARAMETER_COMPANY>
  <PARAMETER_USER>sample string 11</PARAMETER_USER>
  <PARAMETER_VOUCHER>sample string 12</PARAMETER_VOUCHER>
  <REMARKS>sample string 24</REMARKS>
  <TABLE_NAME>sample string 5</TABLE_NAME>
  <TEST_DATA>sample string 23</TEST_DATA>
  <VALIDATION_1>sample string 13</VALIDATION_1>
  <VALIDATION_1_MESSAGE>sample string 14</VALIDATION_1_MESSAGE>
  <VALIDATION_2>sample string 15</VALIDATION_2>
  <VALIDATION_2_MESSAGE>sample string 16</VALIDATION_2_MESSAGE>
  <VALIDATION_3>sample string 17</VALIDATION_3>
  <VALIDATION_3_MESSAGE>sample string 18</VALIDATION_3_MESSAGE>
  <VALIDATION_4>sample string 19</VALIDATION_4>
  <VALIDATION_4_MESSAGE>sample string 20</VALIDATION_4_MESSAGE>
  <VALIDATION_5>sample string 21</VALIDATION_5>
  <VALIDATION_5_MESSAGE>sample string 22</VALIDATION_5_MESSAGE>
</FormWiseControlDocumentations>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MID"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FORM_NAME"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CONTROL_NAME"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CONTROL_TYPE"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TABLE_NAME"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FIELD_NAME"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DATA_TYPE"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MAX_LENGTH"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PARAMETER_COMPANY"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PARAMETER_BRANCH"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PARAMETER_USER"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PARAMETER_VOUCHER"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_1"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_1_MESSAGE"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_2"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_2_MESSAGE"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_3"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_3_MESSAGE"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_4"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_4_MESSAGE"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_5"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VALIDATION_5_MESSAGE"

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TEST_DATA"

sample string 23
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="REMARKS"

sample string 24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MASK"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

FormWiseControlDocumentationsAddResult
NameDescriptionTypeAdditional information
status

string

None.

message

string

None.

formWiseControlDocumentation

FormWiseControlDocumentations

None.

Response Formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "message": "sample string 2",
  "formWiseControlDocumentation": {
    "MID": 1,
    "FORM_NAME": "sample string 2",
    "CONTROL_NAME": "sample string 3",
    "CONTROL_TYPE": "sample string 4",
    "TABLE_NAME": "sample string 5",
    "FIELD_NAME": "sample string 6",
    "DATA_TYPE": "sample string 7",
    "MAX_LENGTH": 8,
    "PARAMETER_COMPANY": "sample string 9",
    "PARAMETER_BRANCH": "sample string 10",
    "PARAMETER_USER": "sample string 11",
    "PARAMETER_VOUCHER": "sample string 12",
    "VALIDATION_1": "sample string 13",
    "VALIDATION_1_MESSAGE": "sample string 14",
    "VALIDATION_2": "sample string 15",
    "VALIDATION_2_MESSAGE": "sample string 16",
    "VALIDATION_3": "sample string 17",
    "VALIDATION_3_MESSAGE": "sample string 18",
    "VALIDATION_4": "sample string 19",
    "VALIDATION_4_MESSAGE": "sample string 20",
    "VALIDATION_5": "sample string 21",
    "VALIDATION_5_MESSAGE": "sample string 22",
    "TEST_DATA": "sample string 23",
    "REMARKS": "sample string 24",
    "MASK": "sample string 25"
  }
}

text/html

Sample:
{"status":"sample string 1","message":"sample string 2","formWiseControlDocumentation":{"MID":1,"FORM_NAME":"sample string 2","CONTROL_NAME":"sample string 3","CONTROL_TYPE":"sample string 4","TABLE_NAME":"sample string 5","FIELD_NAME":"sample string 6","DATA_TYPE":"sample string 7","MAX_LENGTH":8,"PARAMETER_COMPANY":"sample string 9","PARAMETER_BRANCH":"sample string 10","PARAMETER_USER":"sample string 11","PARAMETER_VOUCHER":"sample string 12","VALIDATION_1":"sample string 13","VALIDATION_1_MESSAGE":"sample string 14","VALIDATION_2":"sample string 15","VALIDATION_2_MESSAGE":"sample string 16","VALIDATION_3":"sample string 17","VALIDATION_3_MESSAGE":"sample string 18","VALIDATION_4":"sample string 19","VALIDATION_4_MESSAGE":"sample string 20","VALIDATION_5":"sample string 21","VALIDATION_5_MESSAGE":"sample string 22","TEST_DATA":"sample string 23","REMARKS":"sample string 24","MASK":"sample string 25"}}

application/xml, text/xml

Sample:
<FormWiseControlDocumentationsAddResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SuntechSupportServices.Models.Documentation">
  <formWiseControlDocumentation>
    <CONTROL_NAME>sample string 3</CONTROL_NAME>
    <CONTROL_TYPE>sample string 4</CONTROL_TYPE>
    <DATA_TYPE>sample string 7</DATA_TYPE>
    <FIELD_NAME>sample string 6</FIELD_NAME>
    <FORM_NAME>sample string 2</FORM_NAME>
    <MASK>sample string 25</MASK>
    <MAX_LENGTH>8</MAX_LENGTH>
    <MID>1</MID>
    <PARAMETER_BRANCH>sample string 10</PARAMETER_BRANCH>
    <PARAMETER_COMPANY>sample string 9</PARAMETER_COMPANY>
    <PARAMETER_USER>sample string 11</PARAMETER_USER>
    <PARAMETER_VOUCHER>sample string 12</PARAMETER_VOUCHER>
    <REMARKS>sample string 24</REMARKS>
    <TABLE_NAME>sample string 5</TABLE_NAME>
    <TEST_DATA>sample string 23</TEST_DATA>
    <VALIDATION_1>sample string 13</VALIDATION_1>
    <VALIDATION_1_MESSAGE>sample string 14</VALIDATION_1_MESSAGE>
    <VALIDATION_2>sample string 15</VALIDATION_2>
    <VALIDATION_2_MESSAGE>sample string 16</VALIDATION_2_MESSAGE>
    <VALIDATION_3>sample string 17</VALIDATION_3>
    <VALIDATION_3_MESSAGE>sample string 18</VALIDATION_3_MESSAGE>
    <VALIDATION_4>sample string 19</VALIDATION_4>
    <VALIDATION_4_MESSAGE>sample string 20</VALIDATION_4_MESSAGE>
    <VALIDATION_5>sample string 21</VALIDATION_5>
    <VALIDATION_5_MESSAGE>sample string 22</VALIDATION_5_MESSAGE>
  </formWiseControlDocumentation>
  <message>sample string 2</message>
  <status>sample string 1</status>
</FormWiseControlDocumentationsAddResult>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="status"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="message"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.MID"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.FORM_NAME"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.CONTROL_NAME"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.CONTROL_TYPE"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.TABLE_NAME"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.FIELD_NAME"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.DATA_TYPE"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.MAX_LENGTH"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.PARAMETER_COMPANY"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.PARAMETER_BRANCH"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.PARAMETER_USER"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.PARAMETER_VOUCHER"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_1"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_1_MESSAGE"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_2"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_2_MESSAGE"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_3"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_3_MESSAGE"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_4"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_4_MESSAGE"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_5"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.VALIDATION_5_MESSAGE"

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.TEST_DATA"

sample string 23
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.REMARKS"

sample string 24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="formWiseControlDocumentation.MASK"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e--