GeoTab data contract | PatchOps Knowledge

Provenance

PublisherGeoTab

API basehttps://my.geotab.com/apiv1

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (4)

authenticate

unknown

Authenticate with MyGeotab and return database/user/session credentials.

Required paramsdatabaseusernamepassword

Entitiessession

Input schema

{
  "type": "object",
  "properties": {
    "database": {},
    "username": {},
    "password": {}
  },
  "additionalProperties": false,
  "required": [
    "database",
    "username",
    "password"
  ]
}

getEntities

read

Read Geotab entities using RPC method Get.

Required paramstypeName

Input schema

{
  "type": "object",
  "properties": {
    "credentials": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "userName": {
          "type": "string"
        },
        "sessionId": {
          "type": "string"
        }
      },
      "required": [
        "database",
        "userName",
        "sessionId"
      ],
      "additionalProperties": false
    },
    "typeName": {
      "type": "string"
    },
    "search": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "resultsLimit": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "typeName"
  ]
}

getFeed

read

Read incremental Geotab feed updates using RPC method GetFeed.

Required paramstypeName

Input schema

{
  "type": "object",
  "properties": {
    "credentials": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "userName": {
          "type": "string"
        },
        "sessionId": {
          "type": "string"
        }
      },
      "required": [
        "database",
        "userName",
        "sessionId"
      ],
      "additionalProperties": false
    },
    "typeName": {
      "type": "string"
    },
    "fromVersion": {
      "type": "string"
    },
    "search": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "resultsLimit": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "typeName"
  ]
}

callMyGeotab

unknown

Generic JSON-RPC caller for arbitrary MyGeotab methods.

Required paramsmethodName

Entitiesrequest

Input schema

{
  "type": "object",
  "properties": {
    "credentials": {
      "type": "object",
      "properties": {
        "database": {
          "type": "string"
        },
        "userName": {
          "type": "string"
        },
        "sessionId": {
          "type": "string"
        }
      },
      "required": [
        "database",
        "userName",
        "sessionId"
      ],
      "additionalProperties": false
    },
    "methodName": {
      "type": "string"
    },
    "params": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "includeCredentials": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "methodName"
  ]
}