Introduction

This project provides an interface to easily access Epiroc Machine data in Node/JS Projects.

Pre-requisites

To use this library, you must bring the following credentials

1. The Base API URL of the API Environment you wish to use (Prod/QA)
2. A Subscription Key from the Epiroc Developer Portal matching the selected environment
3. A specific X-API-KEY Provided by your nominated Epiroc contact.
4. A string value for your local region (Eg: Australia is AUC)

These must be set in a config object which is passed to the constructor when initialising a new EpirocMachinesOnline object.

const machinesOnlineConfig = {
    ocpApiSubscriptionKey: "",
    xApiKey: "",
    machinesOnlineBaseUrl: "",
    famCode: ""
}

Example Usage

const EpirocMachinesOnline = require('epiroc-machinesonline');

const config = {
    ocpApiSubscriptionKey: "SubscriptionKey",
    xApiKey: "ApiKey",
    machinesOnlineBaseUrl: "https://urlToApiEnvironment/public/cmol/proxy/",
    famCode: "AUC"
}

const machinesOnline = new EpirocMachinesOnline(config);

machinesOnline.getApiOnlineStatus().then(() => {
    machinesonline.getMachineById("SomeMachineID").then((data) => {
        console.log(data);
    });
})
.catch((err) => {
    console.log("Machines Online API is offline: " + err);
});

Pagination

All functions which take an index value are paged and will return up to 250 records, and will include a hasMore value of True if additional page calls are required to collect more data.

Functions

The following functions are in this module:

• getApiOnlineStatus - Return 200 if the API is online.
• getNumberOfMachines() - Returns the number of machines available in the API
• getNumberOfMachinesForCustomer(customerId) - Returns the number of machines available for the specific customer
• getCustomersStartingFromIndex(index) - Returns the customer names and id's in the API, with an offset of index.
• getMachinesStartingFromIndex(index) - Returns the machines from the API with an offset of index.
• getMachinesForCustomerStartingFromIndex(index) - As above but only returns machines associated with the specific customer.
• getMachineById(machineId) - Returns the machine object for 1 machine.
• getMachineSubEquipmentByMachineId(machineId) - Returns the major serialised components currently installed on the machine.
• getMachineSubEquipmentInstalledAfterComissioning(machineId) - Returns any major components which were not on the machine when shipped from the factory.
• getMachineSubEquipmentAsBuiltFromFactory(machineId) - Returns the major components which were installed on the machine at the time of completion of its manufacturing.
• getMachineModelsStartingFromIndex(index) - Returns all the Models of Machines in the API, with an offset of index.
• getProductLinesStartingFromIndex(index) - Returns all the Product Lines of Machines in the API, with an offset of index.
• getRunningHourTypesStartingFromIndex(index) - Returns all the Running Hour Types for Machines in the API, with an offset of index.