Skip to content

Commit 19a878e

Browse files
authored
Merge pull request #461 from Retzoh/patch-1
Clarify success response for telemetry update
2 parents 5966d67 + 4015175 commit 19a878e

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

agency/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,11 +197,12 @@ Body Params:
197197
| ------------- | ------------------------------ | ----------------- | -------------------------------------------------------------------------------------- |
198198
| `data` | [Telemetry](#telemetry-data)[] | Required | Array of telemetry for one or more vehicles. |
199199

200-
201 Success Response:
200+
200 Success Response:
201201

202-
| Field | Type | Field Description |
203-
| --------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
204-
| `result` | String | Responds with number of successfully written telemetry data points and total number of provided points. |
202+
| Field | Type | Field Description |
203+
| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
204+
| `success` | Integer | Number of successfully written telemetry data points. |
205+
| `total` | Integer | Ttotal number of provided points. |
205206
| `failures` | [Telemetry](#telemetry-data)[] | Array of failed telemetry for zero or more vehicles (empty if all successful). |
206207

207208
400 Failure Response:

0 commit comments

Comments
 (0)