RAMM API

RAMM API

RAMM API

The RAMM API is a Web Service API that allows RAMM Asset and Dispatch data to be read and in many cases modified by externally developed software. This means that your IT department can develop applications specific to the way that you do business.

Access the API

The RAMM API is available at the URL https://apps.ramm.co.nz/rammapi6.1.
The API is documented using Swagger and is available here.

Windows 10 Upgrade

See the API in Action

If you would like to see examples of the RAMM API in action you can download and extract the files from the zip file here. Please be sure to read the extracted ReadMe.txt file. Please note that you need Python on your computer for the downloaded examples to resolve.

RAMM Integration

RAMM Integration

The use of the RAMM API is not currently subject to usage fees. This is subject to change. For further details you should read Campbell Newman’s document explaining the extraction, importation and integration of RAMM data with external systems.
Details


This document describes the extraction, importation and integration of RAMM data with external systems. It also describes the policy for releasing and using this data along with the pricing regimes where appropriate.
Read RAMM Integration by downloading the pdf for printing here.
An Introduction to the RAMM API

See How the API Works

Watch how the Swagger interface allows you to test API requests on either your own or supplied Demo database. Learn how to generate a 24 hour access key for authentication and see how the Model Schemas facilitate coding.
An Introduction to the RAMM API (3:37)
 
 
 

Code 1
{
  "database": "RAMM API Demo",
  "userName": "api_demo",
  "password": "thursday"
}

Code 2
{
  "tableName": "carr_way"
  , "expandLookups": "False"
  , "getGeometry": "True"
  , "loadType": "Specified"
  , "columns": ["carr_way_no", "road_id", "carrway_start_m", "carrway_end_m", "start_name", "end_name", "added_on", "chgd_on"]
  , "filters": [[{"columnName": "added_on", "operator": "GreaterThan", "value": "2015-01-01"}]
, [{"columnName": "chgd_on", "operator": "GreaterThan", "value": "2015-01-01"}]]
}