POST api/batch/insert?APIKey={APIKey}&Slot={Slot}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| APIKey | string |
Required |
|
| Slot | integer |
Required |
Body Parameters
BatchOperationViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CurrentElementType | string |
None. |
|
| Value | string |
None. |
|
| ModuleType | string |
None. |
|
| Elements | Collection of BatchElement |
None. |
|
| Header | string |
None. |
|
| Buttons | Collection of BatchButtonElement |
None. |
|
| SearchFields | Collection of BatchElement |
None. |
|
| SearchButtons | Collection of BatchButtonElement |
None. |
Request Formats
application/json, text/json
Sample:
{
"CurrentElementType": "sample string 1",
"Value": "sample string 2",
"ModuleType": "sample string 3",
"Elements": [
{
"Label": "sample string 1",
"Input": "sample string 2",
"LabelPosition": "sample string 3"
},
{
"Label": "sample string 1",
"Input": "sample string 2",
"LabelPosition": "sample string 3"
}
],
"Header": "sample string 4",
"Buttons": [
{
"Text": "sample string 1"
},
{
"Text": "sample string 1"
}
],
"SearchFields": [
{
"Label": "sample string 1",
"Input": "sample string 2",
"LabelPosition": "sample string 3"
},
{
"Label": "sample string 1",
"Input": "sample string 2",
"LabelPosition": "sample string 3"
}
],
"SearchButtons": [
{
"Text": "sample string 1"
},
{
"Text": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<BatchOperationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.AppCode">
<Buttons>
<BatchButtonElement>
<Text>sample string 1</Text>
</BatchButtonElement>
<BatchButtonElement>
<Text>sample string 1</Text>
</BatchButtonElement>
</Buttons>
<CurrentElementType>sample string 1</CurrentElementType>
<Elements>
<BatchElement>
<Input>sample string 2</Input>
<Label>sample string 1</Label>
<LabelPosition>sample string 3</LabelPosition>
</BatchElement>
<BatchElement>
<Input>sample string 2</Input>
<Label>sample string 1</Label>
<LabelPosition>sample string 3</LabelPosition>
</BatchElement>
</Elements>
<Header>sample string 4</Header>
<ModuleType>sample string 3</ModuleType>
<SearchButtons>
<BatchButtonElement>
<Text>sample string 1</Text>
</BatchButtonElement>
<BatchButtonElement>
<Text>sample string 1</Text>
</BatchButtonElement>
</SearchButtons>
<SearchFields>
<BatchElement>
<Input>sample string 2</Input>
<Label>sample string 1</Label>
<LabelPosition>sample string 3</LabelPosition>
</BatchElement>
<BatchElement>
<Input>sample string 2</Input>
<Label>sample string 1</Label>
<LabelPosition>sample string 3</LabelPosition>
</BatchElement>
</SearchFields>
<Value>sample string 2</Value>
</BatchOperationViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
BatchOperationResult| Name | Description | Type | Additional information |
|---|---|---|---|
| HasError | boolean |
None. |
|
| Error | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"HasError": true,
"Error": "sample string 1"
}
application/xml, text/xml
Sample:
<BatchOperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.AppCode"> <Error>sample string 1</Error> </BatchOperationResult>