Skip to end of banner
Go to start of banner

System Admin Options

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »


Public API for NMIS configuration. "omk/admin/api/v2/"

We can manage the below admin configurations using this API:- http://host/en/omk/admin/api/v2/


API-OPTIONS:-LocationsContactsServicesEscalationsEventsPolling-PolicyUsersAccessCustomersBusinessServices

This API can help you to manage the below operations for the given admin configurations.

NameOperationMethodURLResponseExample

 code-block

LocationsCreatePOSThttp://host/en/omk/admin/api/v2/locations.json

New Location in NMIS configurations.

http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json
{
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "Floor": "",
        "Geocode": "fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "xx.xxxxxxx",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }
LocationsGETGEThttp://host/en/omk/admin/api/v2/locations.jsonLocations present in NMIS configuration file.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations.json
LocationsGETGEThttp://host/en/omk/admin/api/v2/locations{location-name}.jsonLocations present in NMIS configuration file.http://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Amsterdam.json
{
    "Address1": "",
    "Address2": "",
    "City": "Amsterdam",
    "Country": "Netherlands",
    "Floor": "",
    "Geocode": "Amsterdam, Netherlands",
    "Latitude": "52.3675734",
    "Location": "Amsterdam",
    "Longitude": "4.9041389",
    "Postcode": "",
    "Room": "",
    "State": "",
    "Suburb": "",
    "_id": "Amsterdam"
}
LocationsUpdatePUThttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonUpdated location entryhttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json
 {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "Floor": "",
        "Geocode": "fake geo code",
        "Latitude": "xx.xxxxxxx",
        "Location": "Mandatory param",
        "Longitude": "yy.yyyyyyy",
        "Postcode": "",
        "Room": "",
        "State": "",
        "Suburb": ""
    }
LocationsDeleteDELETEhttp://host/en/omk/admin/api/v2/locations/{location-name}.jsonDeletes the location entry from configurationshttp://apollo.opmantek.net:8080/en/omk/admin/api/v2/locations/Mandatory param.json

Important: All this methods are authenticated. 

Operation

Method

URL

Example

AuthenticatePOSThttp://host/en/omk/admin/login
{"username": "username", "password": "password"}

We should receive a 200 response and a cookie, that we can reuse for next API calls. 




  • No labels