Snowplow open interface API documentation version v1

Path: /v1/snowplow

Description

Information of snowplow units in a specific contract. The information includes units' real-time position, and conducted operations. One can query historical data by simply passing parameter. Fetching details of machine type and operation are also supported.

/snowplow

Fetch relevant information about snow plow units

get

get

Find all available snowplow units. Returns relevant information of all units.

get

get

Find snowplow unit by ID and query data by history. Returns an unit with the specific ID or its location history with parameter history.

Find snowplow unit by ID and query data by history. Returns an unit with the specific ID or its location history with parameter history.

URI Parameters

  • id: required (integer)

    ID of unit that will to be fetched

Query Parameters

  • history: (integer)

    Fetch historical location data of unit with specific ID

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema" : "http://json-schema.org/draft-03/schema" ,
  "type" : "object" ,
  "required" : true ,
  "properties" : {
    "location_history" : {
      "required" : false ,
      "type" : "array"
    },
    "id" : {
      "required" : true ,
      "type" : "number"
    },
    "name" : {
      "required" : true ,
      "type" : "String"
    },
    "machine_type" : {
      "required" : true ,
      "type" : "String"
    },
    "last_location" : {
      "required" : true ,
      "type" : "object" ,
      "properties" : {
	    "timestamp" : {
	      "required" : true ,
	      "type" : "date"
	    },
	    "coords" : {
	      "required" : true ,
	      "type" : "String"
	    },
	    "events" : {
	      "required" : true ,
	      "type" : "array"
	    }	
      }
    }
  }
}

Example:

[
  {
	"id": 1234567,
	"name": "ABC-123",
	"machine_type": "traktori",
	"last_location": {
		"timestamp": "2015-09-30 13:13:54",
		"coords": "(23.6380033519744 61.5116566686367)",
		"events": ["au"]
	}
  }
]

HTTP status code 404

No unit found by specific ID

Body

Type: application/json

get

get

Find all machine types available in system without contract restriction. Returns relevant information of all machine types.

get

get

Find machine type available in system by ID. Returns machine type with the specific ID .

Find machine type available in system by ID. Returns machine type with the specific ID .

URI Parameters

  • id: required (integer)

    ID of machine type that will to be fetched

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema" : "http://json-schema.org/draft-03/schema" ,
  "type" : "object" ,
  "required" : true ,
  "properties" : {
    "id" : {
      "required" : true ,
      "type" : "number"
    },
    "kaytossa" : {
      "required" : false ,
      "type" : "boolean"
    },
    "name" : {
      "required" : true ,
      "type" : "String"
    }
  }
}

Example:

[
  {
    "id": 1234567,
	"kaytossa": true,
	"name": "Henkilöauto, oma"
  }
]

HTTP status code 404

No machine type found by specific ID

Body

Type: application/json

get

get

Pattern: /mt/query?id={searchId}. Query machine type available in system by search ID. Returns machine type with the specific search ID. Machine type SearchId: 1: Kuorma-auto 2: Monitoimiautot 3: Willet ja Traktorit 4: Pyöräkuormaajat

get

get

Find main operation available in system by ID. Returns main operation with the specific ID .

Find main operation available in system by ID. Returns main operation with the specific ID .

URI Parameters

  • id: required (integer)

    ID of main operation that will to be fetched

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema" : "http://json-schema.org/draft-03/schema" ,
  "type" : "object" ,
  "required" : true ,
  "properties" : {
    "id" : {
      "required" : true ,
      "type" : "number"
    },
    "kaytossa" : {
      "required" : false ,
      "type" : "boolean"
    },
    "name" : {
      "required" : true ,
      "type" : "String"
    },
    "orderNumber" : {
      "required" : false ,
      "type" : "String"
    },
    "type" : {
      "required" : false ,
      "type" : "String"
    }
  }
}

Example:

[
  {
	"id": 1234567,
	"kaytossa": true,
	"name": "Ajoreitit",
	"orderNumber": null,
	"type": null
  }
]

HTTP status code 404

No main operation found by specific ID

Body

Type: application/json

get

get

Find all operations available in system with operation restriction. The operation is defined in scope of given contract and this interface returns relevant information of all operations in specific contract.

get

get

Find operation available in system by ID. Returns operation with the specific ID .

Find operation available in system by ID. Returns operation with the specific ID .

URI Parameters

  • id: required (integer)

    ID of operation that will to be fetched

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema" : "http://json-schema.org/draft-03/schema" ,
  "type" : "object" ,
  "required" : true ,
  "properties" : {
    "id" : {
      "required" : true ,
      "type" : "number"
    },
    "kaytossa" : {
      "required" : false ,
      "type" : "boolean"
    },
    "name" : {
      "required" : true ,
      "type" : "String"
    },
    "operationId" : {
      "required" : false ,
      "type" : "number"
    },
    "type" : {
      "required" : false ,
      "type" : "String"
    },
    "weight" : {
      "required" : false ,
      "type" : "number"
    }
  }
}

Example:

[
  {
	"id": 123,
	"kaytossa": true,
	"name": "Ajoneuvojen lähisiirrot ( talvikunnossapito )",
	"operationId": null,
	"type": 0,
	"weight": 76.0,
  }
]

HTTP status code 404

No operation found by specific ID

Body

Type: application/json

get

get

Pattern: /query?since={time}&op={operationId}&mt={machineTypeid}&limit={amount}.
Query snowplow unit data by parameters. Returns units fulfill the query conditions. At least one parameter should be provided.