JT808Gateway/api/README.md

JT808 WebApi服务

基地址：http://localhost:828/jt808api/

数据格式：只支持Json格式

默认端口：828

1.统一下发设备消息服务

基于Tcp统一下发设备消息服务

基于Udp统一下发设备消息服务

2.管理会话服务

基于Tcp管理会话服务

基于Udp管理会话服务

3.转发地址过滤服务

基于Tcp转发地址过滤服务

4.消息包计数服务

基于Tcp消息包计数服务

基于Udp消息包计数服务

统一对象返回 JT808ResultDto<T>

属性	数据类型	参数说明
Message	string	消息描述
Code	int	状态码
Data	T（泛型）	数据

返回Code[状态码]说明：

状态码	说明
200	返回成功
201	内容为空
404	没有该服务
500	服务内部错误

基于Tcp统一下发设备消息服务

请求地址：UnificationTcpSend

请求方式：POST

请求参数：

属性	数据类型	参数说明
TerminalPhoneNo	string	设备终端号
Data	byte[]	JT808 byte[]数组

返回数据：

属性	数据类型	参数说明
Data	bool	是否成功

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":true
}

基于Udp统一下发设备消息服务

请求地址：UnificationUdpSend

请求方式：POST

请求参数：

属性	数据类型	参数说明
TerminalPhoneNo	string	设备终端号
Data	byte[]	JT808 byte[]数组

返回数据：

属性	数据类型	参数说明
Data	bool	是否成功

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":true
}

基于Tcp管理会话服务

统一会话信息对象返回 JT808TcpSessionInfoDto

属性	数据类型	参数说明
LastActiveTime	DateTime	最后上线时间
StartTime	DateTime	上线时间
TerminalPhoneNo	string	终端手机号
RemoteAddressIP	string	远程ip地址

1.获取会话集合

请求地址：Session/Tcp/GetAll

请求方式：GET

返回数据：

属性	数据类型	参数说明
Data	List<JT808TcpSessionInfoDto>	实际会话信息集合

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":[
        {
            "LastActiveTime":"2018-11-27 20:00:00",
            "StartTime":"2018-11-25 20:00:00",
            "TerminalPhoneNo":"123456789012",
            "RemoteAddressIP":"127.0.0.1:11808"
        },{
            "LastActiveTime":"2018-11-27 20:00:00",
            "StartTime":"2018-11-25 20:00:00",
            "TerminalPhoneNo":"123456789013",
            "RemoteAddressIP":"127.0.0.1:11808"
        }
    ]
}

2.通过设备终端号移除对应会话

请求地址：Session/Tcp/RemoveByTerminalPhoneNo

请求方式：POST

请求参数：

属性	数据类型	参数说明
terminalPhoneNo	string	设备终端号

返回数据：

属性	数据类型	参数说明
Data	bool	是否成功

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":true
}

基于Tcp转发地址过滤服务

1.添加转发过滤地址

请求地址：Transmit/Add

请求方式：POST

请求参数：

属性	数据类型	参数说明
Host	string	ip地址
Port	int	端口号

返回数据：

属性	数据类型	参数说明
Data	bool	是否成功

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":true
}

基于Udp管理会话服务

统一会话信息对象返回 JT808UdpSessionInfoDto

属性	数据类型	参数说明
LastActiveTime	DateTime	最后上线时间
StartTime	DateTime	上线时间
TerminalPhoneNo	string	终端手机号
RemoteAddressIP	string	远程ip地址

1.获取会话集合

请求地址：Session/Udp/GetAll

请求方式：GET

返回数据：

属性	数据类型	参数说明
Data	List<JT808UdpSessionInfoDto>	实际会话信息集合

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":[
        {
            "LastActiveTime":"2018-11-27 20:00:00",
            "StartTime":"2018-11-25 20:00:00",
            "TerminalPhoneNo":"123456789012",
            "RemoteAddressIP":"127.0.0.1:11808"
        },{
            "LastActiveTime":"2018-11-27 20:00:00",
            "StartTime":"2018-11-25 20:00:00",
            "TerminalPhoneNo":"123456789013",
            "RemoteAddressIP":"127.0.0.1:11808"
        }
    ]
}

2.通过设备终端号移除对应会话

请求地址：Session/Udp/RemoveByTerminalPhoneNo

请求方式：POST

请求参数：

属性	数据类型	参数说明
terminalPhoneNo	string	设备终端号

返回数据：

属性	数据类型	参数说明
Data	bool	是否成功

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":true
}

2.删除转发过滤地址（不能删除在网关服务器配置文件配的地址）

请求地址：Transmit/Remove

请求方式：POST

请求参数：

属性	数据类型	参数说明
Host	string	ip地址
Port	int	端口号

返回数据：

属性	数据类型	参数说明
Data	bool	是否成功

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":true
}

3.获取转发过滤地址信息集合

请求地址：Transmit/GetAll

请求方式：GET

返回数据：

属性	数据类型	参数说明
Data	List<string>	远程ip地址

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":[
        "127.0.0.1:6665",
        "127.0.0.1:6667"
    ]
}

基于Tcp消息包计数服务

请求地址：GetTcpAtomicCounter

请求方式：GET

返回数据：

属性	数据类型	参数说明
MsgSuccessCount	long	消息包成功数
MsgFailCount	long	消息包失败数

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":{
        "MsgSuccessCount":10000,
        "MsgFailCount":0
    }
}

基于Udp消息包计数服务

请求地址：GetUdpAtomicCounter

请求方式：GET

返回数据：

属性	数据类型	参数说明
MsgSuccessCount	long	消息包成功数
MsgFailCount	long	消息包失败数

返回结果：

{
    "Message":"",
    "Code":200,
    "Data":{
        "MsgSuccessCount":1000,
        "MsgFailCount":0
    }
}