Skip to content
j-a-vandervalkPublic

About

This project is for all things locus. If focuses on using an API to collect container location data.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Container Location Service

Usage

All responses will have the form:

{
  "message": "Code assigned to transaction",
  "data": "Mixed type holding the contents of the response"
}

Subsequent response definitions will only detail the expected value of the data field

List all container locations

Definitions

GET /container/loacations

Response

  • 200 OK on success
[
  {
      "DeviceId":"TEST0000995",
      "DeviceType":1,
      "SourceId":"006120215000099",
      "SourceType":4,
      "Logged":"2019-06-04T10:52:00",
      "Properties":{
          "1004":"99.99.1.39",
          "1003":"DIDAmdm006120215000099",
          "1005":"006120215000099",
          "5006":"Emerson Location",
          "5001":"2019-06-04T10:52:00",
          "1015":0.0,
          "1016":-0.2,
          "1017":-14.0,
          "1018":0.1,
          "1019":0.2,
          "1020":29.0,
          "1021":-0.4,
          "1022":0.4,
          "1023":-0.1,
          "1024":-0.5,
          "1025":-0.2,
          "1032":-1.0,
          "1033":0.0,
          "1034":12.5,
          "1035":0.0,
          "1036":12.5,
          "1037":0.0,
          "1048":-0.1,
          "1069":246,
          "1026":49.0,
          "1038":20.0,
          "1039":0,
          "1012":56.1106,
          "1013":10.1586,
          "5011":"00180000",
          "1006":"Thermo King MP-4000",
          "1007":"3.10.0.0",
          "1067":24.0,
          "1000":3,
          "1031":142560,
          "1040":"NonOptimized",
          "1049":7.0,
          "1050":8.0,
          "1051":9.0,
          "1052":50.0,
          "1053":440.0,
          "1065":3.0,
          "1060":10.0,
          "1055":0,
          "1054":2,
          "1056":0,
          "1063":1.1,
          "1068":244,
          "1059":0,
          "1070":19,
          "1071":21,
          "1073":45.0,
          "1074":42,
          "1075":12.0,
          "1076":48.0,
          "1077":-46.0,
          "1078":0.0,
          "1072":23.0,
          "5018":"2019-05-23T21:22:00"
      },
      "Alarms":{
          "10500":"2019-06-04T07:12:44"
      },
      "LegacyAlarms":null
  },
  {
      "DeviceId":"TEST0000996",
      "DeviceType":1,
      "SourceId":"006120215000099",
      "SourceType":4,
      "Logged":"2019-06-04T10:52:00",
      "Properties":{
          "1004":"99.99.1.39",
          "1003":"DIDAmdm006120215000099",
          "1005":"006120215000099",
          "5006":"Emerson Location",
          "5001":"2019-06-04T10:52:00",
          "1015":0.0,
          "1016":-0.2,
          "1017":-14.0,
          "1018":0.1,
          "1019":0.2,
          "1020":29.0,
          "1021":-0.4,
          "1022":0.4,
          "1023":-0.1,
          "1024":-0.5,
          "1025":-0.2,
          "1032":-1.0,
          "1033":0.0,
          "1034":12.5,
          "1035":0.0,
          "1036":12.5,
          "1037":0.0,
          "1048":-0.1,
          "1069":246,
          "1026":49.0,
          "1038":20.0,
          "1039":0,
          "1012":56.1106,
          "1013":10.1586,
          "5011":"00180000",
          "1006":"Thermo King MP-4000",
          "1007":"3.10.0.0",
          "1067":24.0,
          "1000":3,
          "1031":142560,
          "1040":"NonOptimized",
          "1049":7.0,
          "1050":8.0,
          "1051":9.0,
          "1052":50.0,
          "1053":440.0,
          "1065":3.0,
          "1060":10.0,
          "1055":0,
          "1054":2,
          "1056":0,
          "1063":1.1,
          "1068":244,
          "1059":0,
          "1070":19,
          "1071":21,
          "1073":45.0,
          "1074":42,
          "1075":12.0,
          "1076":48.0,
          "1077":-46.0,
          "1078":0.0,
          "1072":23.0,
          "5018":"2019-05-23T21:22:00"
      },
      "Alarms":{
          "10500":"2019-06-04T07:12:44"
      },
      "LegacyAlarms":null
  }
]

List singular container location

Definitions

GET /container/loacation/<string:device_id>

Response

  • 404 not found if the identifier does not exist
  • 200 OK on success
  • 204 No Content on success but no content found
{
    "DeviceId":"TEST0000995",
    "DeviceType":1,
    "SourceId":"006120215000099",
    "SourceType":4,
    "Logged":"2019-06-04T10:52:00",
    "Properties":{
        "1004":"99.99.1.39",
        "1003":"DIDAmdm006120215000099",
        "1005":"006120215000099",
        "5006":"Emerson Location",
        "5001":"2019-06-04T10:52:00",
        "1015":0.0,
        "1016":-0.2,
        "1017":-14.0,
        "1018":0.1,
        "1019":0.2,
        "1020":29.0,
        "1021":-0.4,
        "1022":0.4,
        "1023":-0.1,
        "1024":-0.5,
        "1025":-0.2,
        "1032":-1.0,
        "1033":0.0,
        "1034":12.5,
        "1035":0.0,
        "1036":12.5,
        "1037":0.0,
        "1048":-0.1,
        "1069":246,
        "1026":49.0,
        "1038":20.0,
        "1039":0,
        "1012":56.1106,
        "1013":10.1586,
        "5011":"00180000",
        "1006":"Thermo King MP-4000",
        "1007":"3.10.0.0",
        "1067":24.0,
        "1000":3,
        "1031":142560,
        "1040":"NonOptimized",
        "1049":7.0,
        "1050":8.0,
        "1051":9.0,
        "1052":50.0,
        "1053":440.0,
        "1065":3.0,
        "1060":10.0,
        "1055":0,
        "1054":2,
        "1056":0,
        "1063":1.1,
        "1068":244,
        "1059":0,
        "1070":19,
        "1071":21,
        "1073":45.0,
        "1074":42,
        "1075":12.0,
        "1076":48.0,
        "1077":-46.0,
        "1078":0.0,
        "1072":23.0,
        "5018":"2019-05-23T21:22:00"
    },
    "Alarms":{
        "10500":"2019-06-04T07:12:44"
    },
    "LegacyAlarms":null
}

Registering a ship location

Definition

POST /locus/container/location

Arguments

  • Please see sample incoming JSON below

Response

  • 201 Created on success
{
    "DeviceId":"TEST0000995",
    "DeviceType":1,
    "SourceId":"006120215000099",
    "SourceType":4,
    "Logged":"2019-06-04T10:52:00",
    "Properties":{
        "1004":"99.99.1.39",
        "1003":"DIDAmdm006120215000099",
        "1005":"006120215000099",
        "5006":"Emerson Location",
        "5001":"2019-06-04T10:52:00",
        "1015":0.0,
        "1016":-0.2,
        "1017":-14.0,
        "1018":0.1,
        "1019":0.2,
        "1020":29.0,
        "1021":-0.4,
        "1022":0.4,
        "1023":-0.1,
        "1024":-0.5,
        "1025":-0.2,
        "1032":-1.0,
        "1033":0.0,
        "1034":12.5,
        "1035":0.0,
        "1036":12.5,
        "1037":0.0,
        "1048":-0.1,
        "1069":246,
        "1026":49.0,
        "1038":20.0,
        "1039":0,
        "1012":56.1106,
        "1013":10.1586,
        "5011":"00180000",
        "1006":"Thermo King MP-4000",
        "1007":"3.10.0.0",
        "1067":24.0,
        "1000":3,
        "1031":142560,
        "1040":"NonOptimized",
        "1049":7.0,
        "1050":8.0,
        "1051":9.0,
        "1052":50.0,
        "1053":440.0,
        "1065":3.0,
        "1060":10.0,
        "1055":0,
        "1054":2,
        "1056":0,
        "1063":1.1,
        "1068":244,
        "1059":0,
        "1070":19,
        "1071":21,
        "1073":45.0,
        "1074":42,
        "1075":12.0,
        "1076":48.0,
        "1077":-46.0,
        "1078":0.0,
        "1072":23.0,
        "5018":"2019-05-23T21:22:00"
    },
    "Alarms":{
        "10500":"2019-06-04T07:12:44"
    },
    "LegacyAlarms":null
}

About

This project is for all things locus. If focuses on using an API to collect container location data.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages