Application Programming Interface (API)


This site has a limited set of RESTful API calls you can make to pull near real-time configuration data covering our fleet.

Method Syntax Purpose Example
GET /svc/GetShips List ships in the NOAA fleet Link
GET /svc/GetCurrentVesselMetadata/{shipCode} Get latest high-level metadata for a ship Link
GET /svc/GetCurrentDeviceConfiguration/{shipCode} Get current device configuration for a given ship Link
GET /svc/GetXmlReleaseIDsForShipDay/{shipCode}/{date} Get IDs of device configuration(s) used by a ship on a specific date (yyyy-MM-dd) Link
GET /svc/GetDeviceConfiguration/{xmlReleaseID} Get device configuration XML by its ID Link
GET /svc/GetDeviceConfigSchemaDef/{xmlReleaseID} Get the XML schema definition for a device configuration XML by its ID Link
GET /svc/GetDeviceConfigurationChanges/{xmlReleaseID} Get only the delta between a device configuration and it's predecessor Link
GET /svc/GetMessageDefinitionForDataField/{xmlReleaseID}/{datafieldID} Get the Message Definition XML for a specific data field in a specific device configuration release Link
GET /svc/GetPhysicalDeviceForDataField/{xmlReleaseID}/{datafieldID} Get the Physical Device XML (if any) supplying data to a specific data field in a specific device configuration release Link
GET /svc/GetImage/{fileID}/{isThumbnail?} Get an image by ID, optionally specify if you want full resolution or thumbnail (if available) Full Res
Thumbnail
GET /svc/DownloadFile/{fileID} Download a file by ID Link
GET /svc/DownloadConfig/{xmlReleaseID} Download a specific device configuration file Link
GET /svc/DownloadSchemaDef/{xmlReleaseID} Download the XML schema definition file for a device configuration XML by its ID Link