POST api/Protocol/Add
增加一条协议
Request Information
URI Parameters
None.
Body Parameters
M_AddProtocol| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
协议名称 |
string |
Required |
| Type |
协议类型,Modbus/Customize |
string |
Required |
| Note |
备注 |
string |
Required |
| Version |
版本号,格式举例:1.0.1 |
string |
Required |
| List |
字段列表 |
Collection of ProtocolFunction |
Required |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Type": "sample string 2",
"Note": "sample string 3",
"Version": "sample string 4",
"List": [
{
"FunCode": 1,
"Addr": 2,
"ID": 3,
"Num": 4,
"Attr": "sample string 5",
"List": [
{
"Name": "sample string 1",
"Index": 2,
"Type": "sample string 3",
"Factor": 4.1,
"Keep": 5,
"Unit": "sample string 6"
},
{
"Name": "sample string 1",
"Index": 2,
"Type": "sample string 3",
"Factor": 4.1,
"Keep": 5,
"Unit": "sample string 6"
}
]
},
{
"FunCode": 1,
"Addr": 2,
"ID": 3,
"Num": 4,
"Attr": "sample string 5",
"List": [
{
"Name": "sample string 1",
"Index": 2,
"Type": "sample string 3",
"Factor": 4.1,
"Keep": 5,
"Unit": "sample string 6"
},
{
"Name": "sample string 1",
"Index": 2,
"Type": "sample string 3",
"Factor": 4.1,
"Keep": 5,
"Unit": "sample string 6"
}
]
}
]
}
application/xml, text/xml
Sample:
<M_AddProtocol xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.DP.Models">
<List xmlns:d2p1="http://schemas.datacontract.org/2004/07/Data">
<d2p1:ProtocolFunction>
<d2p1:Addr>2</d2p1:Addr>
<d2p1:Attr>sample string 5</d2p1:Attr>
<d2p1:FunCode>1</d2p1:FunCode>
<d2p1:ID>3</d2p1:ID>
<d2p1:List>
<d2p1:ProtocolItem>
<d2p1:Factor>4.1</d2p1:Factor>
<d2p1:Index>2</d2p1:Index>
<d2p1:Keep>5</d2p1:Keep>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>sample string 3</d2p1:Type>
<d2p1:Unit>sample string 6</d2p1:Unit>
</d2p1:ProtocolItem>
<d2p1:ProtocolItem>
<d2p1:Factor>4.1</d2p1:Factor>
<d2p1:Index>2</d2p1:Index>
<d2p1:Keep>5</d2p1:Keep>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>sample string 3</d2p1:Type>
<d2p1:Unit>sample string 6</d2p1:Unit>
</d2p1:ProtocolItem>
</d2p1:List>
<d2p1:Num>4</d2p1:Num>
</d2p1:ProtocolFunction>
<d2p1:ProtocolFunction>
<d2p1:Addr>2</d2p1:Addr>
<d2p1:Attr>sample string 5</d2p1:Attr>
<d2p1:FunCode>1</d2p1:FunCode>
<d2p1:ID>3</d2p1:ID>
<d2p1:List>
<d2p1:ProtocolItem>
<d2p1:Factor>4.1</d2p1:Factor>
<d2p1:Index>2</d2p1:Index>
<d2p1:Keep>5</d2p1:Keep>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>sample string 3</d2p1:Type>
<d2p1:Unit>sample string 6</d2p1:Unit>
</d2p1:ProtocolItem>
<d2p1:ProtocolItem>
<d2p1:Factor>4.1</d2p1:Factor>
<d2p1:Index>2</d2p1:Index>
<d2p1:Keep>5</d2p1:Keep>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>sample string 3</d2p1:Type>
<d2p1:Unit>sample string 6</d2p1:Unit>
</d2p1:ProtocolItem>
</d2p1:List>
<d2p1:Num>4</d2p1:Num>
</d2p1:ProtocolFunction>
</List>
<Name>sample string 1</Name>
<Note>sample string 3</Note>
<Type>sample string 2</Type>
<Version>sample string 4</Version>
</M_AddProtocol>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
M_Response| Name | Description | Type | Additional information |
|---|---|---|---|
| Contant |
内容,包含返回所需要的类 |
Object |
Required |
| Status |
状态 |
integer |
Required |
| Msg |
信息 |
string |
Required |
| Num |
数值,数据变动条数或增加时返回的ID |
integer |
Required |
Response Formats
application/json, text/json
Sample:
{
"Contant": {},
"Status": 2,
"Msg": "sample string 3",
"Num": 4
}
application/xml, text/xml
Sample:
<M_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.DP.Models"> <Msg>sample string 3</Msg> <Num>4</Num> <Status>2</Status> <Contant /> </M_Response>