7. Response
The specific fields in the response vary depending on the result code.
7.1 Success
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=0 |
result=0 |
No |
- |
|
requestno |
requestno |
No |
int |
|
message |
message |
Yes |
string[33] |
|
traceerase |
cleartrace |
No |
int 0-1 |
|
fixinterval |
fixinterval |
No |
int 0-9999 |
Time interval (seconds) for daytime closing processing |
fixlogcnt |
fixlogcnt |
No |
int 0-9999 |
Number of logs for daytime closing processing |
playlimit |
limit |
No |
int 0-UINT_MAX |
Play limit |
playlimitsig |
limitsig |
No |
signature |
|
playhistory |
history |
No |
history |
|
nearfull |
nearfull |
No |
nearfull |
Nearfull value, including flags |
nearfullsig |
nearfullsig |
No |
signature |
|
linelimit |
sendlimit |
No |
int 1-* |
Max rows per request allowable |
protocolver |
protocolver |
No |
float5 |
Protocol version |
7.2 Failure
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=1 |
result=1 |
No |
- |
|
requestno |
requestno |
No |
int |
|
message |
message |
No |
string[33] |
|
7.3 Maintenance
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=2 |
result=2 |
No |
- |
|
requestno |
requestno |
Yes |
int |
|
7.4 Busy
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=3 |
result=3 |
No |
- |
|
requestno |
requestno |
Yes |
int |
|
waittime |
waittime |
No |
int 0-86400 |
Seconds to wait before next request |
7.5 Internal server error
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=4 |
result=4 |
No |
- |
|
requestno |
requestno |
Yes |
int |
|
message |
message |
No |
string[33] |
|
7.6 Request parameter error
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=5 |
result=5 |
No |
- |
|
requestno |
requestno |
Yes |
int |
|
linelimit |
sendlimit |
No |
int 1-* |
Max rows per request allowable |
message |
message |
No |
string[33] |
|
7.7 Request next request
This response prompts the client to continue sending its remaining tracelogs. It is nonsensical if traceleft
is zero.
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=6 |
result=6 |
No |
- |
|
requestno |
requestno |
Yes |
int |
|
waittime |
waittime |
No |
int 0-86400 |
Seconds to wait before next request |
linelimit |
sendlimit |
No |
int 1-* |
Max rows per request allowable |
7.8 Invalid
Parameter |
CHN name |
Optional |
Data type |
Comment |
result=9 |
result=9 |
No |
- |
|
requestno |
requestno |
Yes |
int |
|
linelimit |
sendlimit |
No |
int 1-* |
Max rows per request allowable |
playlimit |
limit |
No |
int |
Will always be 0 in this mode |
playlimitsig |
limitsig |
No |
signature |
|
nearfull |
nearfull |
No |
nearfull |
Will always be 0 in this mode |
nearfullsig |
nearfullsig |
No |
signature |
|