(Quick Reference)

4 Checking Status API - Reference Documentation

Authors: John Cartwright, Peter Elespuru, John LaRocque, Heather McCullough, Evan McQuinn, David Neufeld, Robert Prentice, Anju Shah, Ken Tanaka, Lisa Taylor, Richard Fozzard, Martin Aubrey

Version: 1.13.5+23

4 Checking Status API

Checking the Status of an Order

To check status on an order, GET from this URL:

https://www.ngdc.noaa.gov/next-web/rest/orders/ID

Replace "ID" with the ID number of the order you want to check.

You will receive a JSON data response like this (all on one line):

{
  "id":1,
  "dateCreated":"'2012-05-29 15:56:28.749'",
  "lastUpdated":"'2012-05-29 15:56:28.749'",
  "elapsedTime":null,
  "status":"NEW",
  "datasetCount":1,
  "errorCount":0,
  "positionInQueue":1,
  "items":[
    {"dataset":"Multibeam", "url":"'http://localhost:8080/next-web/item?id=1'"}
  ]
}

Error responses

If you ask for an order number that is not in the system (https://www.ngdc.noaa.gov/next-web/rest/orders/233),

{"message": "Order 233 not found"}

or if you provide a non-integer order number (https://www.ngdc.noaa.gov/next-web/rest/orders/bogus),

{"message":"invalid order ID. Must be an integer"}

<< 3Ordering Data API

5Delivery Details >>

4 Checking Status API - Reference Documentation

4 Checking Status API

Checking the Status of an Order

Error responses

Order Creation

Order Status