From 76a5c18506375e1e791b8518d09b2b2e3eddf071 Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Thu, 4 Apr 2019 15:16:11 -0400 Subject: [PATCH 1/3] Added 400 invalid_data response for failed telemetry data POST --- agency/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/agency/README.md b/agency/README.md index cee15ef8..8ebd4433 100644 --- a/agency/README.md +++ b/agency/README.md @@ -201,10 +201,11 @@ _No content returned on success._ 400 Failure Response: -| `error` | `error_description` | `error_details`[] | -| --------------- | -------------------------------- | ------------------------------- | -| `bad_param` | A validation error occurred. | Array of parameters with errors | -| `missing_param` | A required parameter is missing. | Array of missing parameters | +| `error` | `error_description` | `error_details`[] | +| --------------- | ------------------------------------ | ------------------------------- | +| `bad_param` | A validation error occurred. | Array of parameters with errors | +| `invalid_data` | None of the provided data was valid. | | +| `missing_param` | A required parameter is missing. | Array of missing parameters | ## Service Areas From c2127ef6f56feee836867a8f28d1fb1ba778854c Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Thu, 4 Apr 2019 15:26:51 -0400 Subject: [PATCH 2/3] Update 201 response --- agency/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/agency/README.md b/agency/README.md index 8ebd4433..c52558ae 100644 --- a/agency/README.md +++ b/agency/README.md @@ -197,7 +197,10 @@ Body Params: 201 Success Response: -_No content returned on success._ +| Field | Type | Field Description | +| --------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- | +| `result` | String | Responds with number of successfully written telemetry data points and total number of provided points. | +| `failures | [Telemetry](#telemetry-data)[] | Array of failed telemetry for one or more vehicles. | 400 Failure Response: From e12e49cb830b0c581ef8575c88bd7a49589c8fe6 Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Thu, 4 Apr 2019 15:31:56 -0400 Subject: [PATCH 3/3] Improve field description for failures --- agency/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agency/README.md b/agency/README.md index c52558ae..401d5267 100644 --- a/agency/README.md +++ b/agency/README.md @@ -200,7 +200,7 @@ Body Params: | Field | Type | Field Description | | --------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- | | `result` | String | Responds with number of successfully written telemetry data points and total number of provided points. | -| `failures | [Telemetry](#telemetry-data)[] | Array of failed telemetry for one or more vehicles. | +| `failures | [Telemetry](#telemetry-data)[] | Array of failed telemetry for zero or more vehicles (empty if all successful). | 400 Failure Response: