From 189867f45b01440d9595476b6fd348f8cc7b5936 Mon Sep 17 00:00:00 2001 From: Aaron Brethorst Date: Wed, 20 Mar 2024 11:46:12 -0700 Subject: [PATCH] Convert report-problem-with-stop method to new rest_api layout --- .../report-problem-with-stop-1_75403.json | 1 + .../where/methods/report-problem-with-stop.md | 30 +++++-------------- 2 files changed, 9 insertions(+), 22 deletions(-) create mode 100644 src/api/example_responses/report-problem-with-stop-1_75403.json diff --git a/src/api/example_responses/report-problem-with-stop-1_75403.json b/src/api/example_responses/report-problem-with-stop-1_75403.json new file mode 100644 index 0000000..1a0c961 --- /dev/null +++ b/src/api/example_responses/report-problem-with-stop-1_75403.json @@ -0,0 +1 @@ +{"code":200,"currentTime":1710960205535,"data":{},"text":"OK","version":2} \ No newline at end of file diff --git a/src/api/where/methods/report-problem-with-stop.md b/src/api/where/methods/report-problem-with-stop.md index a237876..445710c 100644 --- a/src/api/where/methods/report-problem-with-stop.md +++ b/src/api/where/methods/report-problem-with-stop.md @@ -1,29 +1,15 @@ --- -layout: page +layout: rest_api title: report-problem-with-stop Method +description: | + Submit a user-generated problem report for a particular stop. The reporting mechanism provides lots of fields that can + be specified to give more context about the details of the problem (which trip, stop, vehicle, etc was involved), + making it easier for a developer or transit agency staff to diagnose the problem. These reports feed into the + problem reporting admin interface. +sample_request_url: https://api.pugetsound.onebusaway.org/api/where/report-problem-with-stop/1_75403.json?key=TEST&code=stop_name_wrong +example_response_file: report-problem-with-stop-1_75403.json --- -Submit a user-generated problem report for a particular stop. The reporting mechanism provides lots of fields that can -be specified to give more context about the details of the problem (which trip, stop, vehicle, etc was involved), -making it easier for a developer or transit agency staff to diagnose the problem. These reports feed into the -problem reporting admin interface. - -## Sample Request - -[http://api.pugetsound.onebusaway.org/api/where/report-problem-with-stop/1_75403.json?key=TEST&code=stop_name_wrong](http://api.pugetsound.onebusaway.org/api/where/report-problem-with-stop/1_75403.json?key=TEST&code=stop_name_wrong) - -## Sample Response - -~~~~ - - 2 - 200 - 1318879898047 - OK - - -~~~~ - ## Request Parameters * stopId - the trip id, encoded directly in the URL: