{ "swagger": "2.0", "info": { "version": "v1.0", "title": "ThreedTracking.API.WebApi" }, "host": "api.3dtracking.net", "schemes": [ "https" ], "paths": { "/api/v1.0/Alerts/Alerts/AlertTypeList": { "get": { "tags": [ "Alerts" ], "summary": "This will return a list of alert types the user has access to", "operationId": "Alerts_AlertTypeList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertTypeListItem[]]" } } } } }, "/api/v1.0/Alerts/Alerts/List": { "get": { "tags": [ "Alerts" ], "summary": "This will return a list of alert notifications the user has access to", "operationId": "Alerts_List", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "AlertTypeUID", "in": "query", "description": "(Optional) This is the unique Alert Type UID which returns only specific Alert Types.", "required": false, "type": "string" }, { "name": "StartUID", "in": "query", "description": "If used it will limit the results to updates that occurred after this StartUID. Please use the StartUID from previous results to determine what to pass through. Pass 0 to start 7 days ago, blank to start 24 hours ago", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertListResult]" } } } } }, "/api/v1.0/Authentication/ErrorCodes": { "get": { "tags": [ "Authentication" ], "summary": "Returns a list of errorcodes that webservices can return.", "operationId": "Authentication_ErrorCodes", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Code.ErrorCode[]]" } } } } }, "/api/v1.0/Authentication/UserAuthenticate": { "get": { "tags": [ "Authentication" ], "summary": "Authenticate a user.", "operationId": "Authentication_UserAuthenticate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserName", "in": "query", "description": "UserName", "required": true, "type": "string" }, { "name": "Password", "in": "query", "description": "Password", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UserSessionToken]" } } } }, "post": { "tags": [ "Authentication" ], "summary": "Authenticate a user.", "operationId": "Authentication_UserAuthenticate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserName", "in": "query", "description": "UserName", "required": true, "type": "string" }, { "name": "Password", "in": "query", "description": "Password", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UserSessionToken]" } } } } }, "/api/v1.0/Authentication/PasswordReminder": { "post": { "tags": [ "Authentication" ], "summary": "Password reset facility for registered users.", "operationId": "Authentication_PasswordReminder", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserName", "in": "query", "description": "The email.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Dispatch/Customer/List": { "get": { "tags": [ "Dispatch" ], "summary": "Gets the customer list.", "operationId": "Customer_CustomerList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer[]]" } } } } }, "/api/v1.0/Dispatch/Customer/{Uid}/Get": { "get": { "tags": [ "Dispatch" ], "summary": "Gets the customer.", "operationId": "Customer_CustomerGet", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The external customer code.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer]" } } } } }, "/api/v1.0/Dispatch/Customer/{Uid}/Exists": { "get": { "tags": [ "Dispatch" ], "summary": "Check a customer Exists.", "operationId": "Customer_CustomerExists", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The external customer code.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Dispatch/Customer/{Uid}/Delete": { "post": { "tags": [ "Dispatch" ], "summary": "Deletes the customer.", "operationId": "Customer_CustomerDelete", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The customer code.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Dispatch/Customer/Create": { "post": { "tags": [ "Dispatch" ], "summary": "Creates the customer.", "operationId": "Customer_Create", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "ExternalCustomerCode", "in": "query", "description": "The external customer code.", "required": true, "type": "string" }, { "name": "Name", "in": "query", "description": "The name of the Customer", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer]" } } } } }, "/api/v1.0/Dispatch/Customer/{Uid}/Update": { "post": { "tags": [ "Dispatch" ], "summary": "Updates the Customer Name or External Code.", "operationId": "Customer_Update", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ExternalCustomerCode", "in": "query", "description": "The external customer code.", "required": true, "type": "string" }, { "name": "Name", "in": "query", "description": "The name of the Customer", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/List": { "get": { "tags": [ "Dispatch" ], "summary": "Retrieves a list of Customer Locations for a customer.", "operationId": "CustomerLocation_CustomerLocationList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation[]]" } } } } }, "/api/v1.0/Dispatch/Customer/Location/StatusList": { "get": { "tags": [ "Dispatch" ], "summary": "Returns a list of location statuses", "operationId": "CustomerLocation_CustomerLocationStatusList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocationStatus[]]" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/{Uid}/Get": { "get": { "tags": [ "Dispatch" ], "summary": "Retrieves information on a specific location.", "operationId": "CustomerLocation_CustomerLocationGet", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" }, { "name": "Uid", "in": "path", "description": "Customer Location Uid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation]" } } } } }, "/api/v1.0/Dispatch/Customer/Location/GetAddressCoordinates": { "get": { "tags": [ "Dispatch" ], "summary": "This will return the closest one or more coordinate matches, depending on your account reversegeocoding provider, for the address details that have been entered.", "operationId": "CustomerLocation_AddressCoordinatesGet", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.AddressCoordinate[]]" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/{Uid}/UpdateStatus": { "post": { "tags": [ "Dispatch" ], "summary": "Updates the Status of a Location.", "operationId": "CustomerLocation_CustomerLocationUpdateStatus", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" }, { "name": "Uid", "in": "path", "description": "Location Uid", "required": true, "type": "string" }, { "name": "CustomerLocationStatusId", "in": "query", "description": "(Required) The customer location status id.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/CreateByAddress": { "post": { "tags": [ "Dispatch" ], "summary": "Creates the customer location by address. It will select the best location for the address that you have entered. If there is more than one result from the Geocode provider we will select their best match.", "operationId": "CustomerLocation_CustomerLocationCreateByAddress", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" }, { "name": "ExternalCustomerLocationCode", "in": "query", "description": "The external customer location code.", "required": true, "type": "string" }, { "name": "CustomerLocationName", "in": "query", "description": "Name of the customer location.", "required": true, "type": "string" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country. Country ISO", "required": true, "type": "string" }, { "name": "Diametre", "in": "query", "description": "The diametre in meters greater than 0.", "required": true, "type": "number", "format": "float" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation]" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/{Uid}/UpdateByAddress": { "post": { "tags": [ "Dispatch" ], "summary": "Updates the customer location by address.", "operationId": "CustomerLocation_CustomerLocationUpdateByAddress", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" }, { "name": "Uid", "in": "path", "description": "Location Uid", "required": true, "type": "string" }, { "name": "ExternalCustomerLocationCode", "in": "query", "description": "The external customer location code.", "required": true, "type": "string" }, { "name": "CustomerLocationName", "in": "query", "description": "Name of the customer location.", "required": true, "type": "string" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country.", "required": true, "type": "string" }, { "name": "Diametre", "in": "query", "description": "The diametre Meters", "required": true, "type": "number", "format": "float" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/CreateByCoordinates": { "post": { "tags": [ "Dispatch" ], "summary": "Creates the customer location by coordinates.", "operationId": "CustomerLocation_CustomerLocationCreateByCoordinates", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" }, { "name": "ExternalCustomerLocationCode", "in": "query", "description": "The external customer location code.", "required": true, "type": "string" }, { "name": "CustomerLocationName", "in": "query", "description": "Name of the customer location.", "required": true, "type": "string" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country.", "required": true, "type": "string" }, { "name": "Latitude", "in": "query", "description": "The latitude.", "required": true, "type": "number", "format": "float" }, { "name": "Longitude", "in": "query", "description": "The longitude.", "required": true, "type": "number", "format": "float" }, { "name": "Diametre", "in": "query", "description": "The diametre Meters", "required": true, "type": "number", "format": "float" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation]" } } } } }, "/api/v1.0/Dispatch/{CustomerUid}/Location/{Uid}/UpdateByCoordinates": { "post": { "tags": [ "Dispatch" ], "summary": "Updates the customer location by coordinates.", "operationId": "CustomerLocation_CustomerLocationUpdateByCoordinates", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "path", "description": "Customer Uid", "required": true, "type": "string" }, { "name": "Uid", "in": "path", "description": "Location Uid", "required": true, "type": "string" }, { "name": "ExternalCustomerLocationCode", "in": "query", "description": "The external customer location code.", "required": true, "type": "string" }, { "name": "CustomerLocationName", "in": "query", "description": "Name of the customer location.", "required": true, "type": "string" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country.", "required": true, "type": "string" }, { "name": "Latitude", "in": "query", "description": "The latitude.", "required": true, "type": "number", "format": "float" }, { "name": "Longitude", "in": "query", "description": "The longitude.", "required": true, "type": "number", "format": "float" }, { "name": "Diametre", "in": "query", "description": "The diametre.", "required": true, "type": "number", "format": "float" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Data/SensorReadingsList": { "get": { "tags": [ "Data" ], "summary": "This will return up to 2500 Sensors since the StartId.", "operationId": "Data_SensorReadingsList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "Comma separated string of UIds of units. Empty or * selects all units", "required": false, "type": "string" }, { "name": "StartId", "in": "query", "description": "If used it will limit the results to updates that occured after this StartId. \r\n Please use the StartId from previous results to determine what to pass through.\r\n Pass 0 to start 7 days ago, blank to start 24 hours ago", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.SensorReadingList]" } } } } }, "/api/v1.0/Data/PositionsList": { "get": { "tags": [ "Data" ], "summary": "This will return up to 500 unit positions with optional input/output data since the startid passed in that the user calling it has access to.", "operationId": "Data_PositionsList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "Comma separated string of UIds of units. Empty or * selects all units", "required": false, "type": "string" }, { "name": "StartId", "in": "query", "description": "If used it will limit the results to updates that occured after this StartId. \r\n Please use the StartId from previous results to determine what to pass through.\r\n Pass 0 to start 7 days ago, blank to start 24 hours ago", "required": false, "type": "integer", "format": "int64" }, { "name": "IncludeInputOutputs", "in": "query", "description": "True - result will return input output data / False - no input output data", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PositionList]" } } } } }, "/api/v1.0/Driver/Driver/List": { "get": { "tags": [ "Driver" ], "summary": "This will return a list of all drivers the user has access to", "operationId": "Driver_List", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverListItem[]]" } } } } }, "/api/v1.0/Driver/Driver/{Uid}": { "get": { "tags": [ "Driver" ], "summary": "This will return a list of all drivers the user has access to", "operationId": "Driver_List", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the driver to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.Driver]" } } } } }, "/api/v1.0/Driver/Driver/{Uid}/Tag/List": { "get": { "tags": [ "Driver" ], "summary": "This will return a list of all drivers the user has access to", "operationId": "Driver_DriverTags", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the driver to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverTag[]]" } } } } }, "/api/v1.0/Driver/Driver/DeleteDriver": { "post": { "tags": [ "Driver" ], "summary": "Driver Delete", "operationId": "Driver_DeleteDriver", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "The Unique ID of the driver to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Driver/Driver/DriverDeAllocation": { "post": { "tags": [ "Driver" ], "summary": "Allocate a driver", "operationId": "Driver_DriverDeAllocation", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "UnitUid", "in": "query", "description": "The Unique ID of the unit", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Driver/Driver/DriverAllocation": { "post": { "tags": [ "Driver" ], "summary": "Allocate a driver", "operationId": "Driver_DriverAllocation", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "UnitUid", "in": "query", "description": "The Unique ID of the unit", "required": true, "type": "string" }, { "name": "DriverUid", "in": "query", "description": "The Unique ID of the driver", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Driver/Driver/AddDriver": { "post": { "tags": [ "Driver" ], "summary": "Driver Add", "operationId": "Driver_AddDriver", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "FirstName", "in": "query", "description": "FirstName of driver", "required": true, "type": "string" }, { "name": "LastName", "in": "query", "description": "LastName of driver", "required": true, "type": "string" }, { "name": "DriverId", "in": "query", "description": "DriverID (This is compulsory field already when creating a driver [Driver on UI])", "required": true, "type": "string" }, { "name": "DisplayName", "in": "query", "description": "DisplayName of Driver", "required": true, "type": "string" }, { "name": "Group", "in": "query", "description": "Assign to Group", "required": true, "type": "string" }, { "name": "Tag", "in": "query", "description": "To assign a Tag to the driver", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverAddResult]" } } } } }, "/api/v1.0/Driver/Driver/EditDriver": { "post": { "tags": [ "Driver" ], "summary": "Driver Edit", "operationId": "Driver_EditDriver", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "The Unique ID of the driver to fetch", "required": true, "type": "string" }, { "name": "DriverId", "in": "query", "description": "DriverID (This is compulsory field already when creating a driver [Driver on UI])", "required": true, "type": "string" }, { "name": "FirstName", "in": "query", "description": "Update the FirstName field, if no value, leave as is", "required": false, "type": "string" }, { "name": "LastName", "in": "query", "description": "Update the LastName field, if no value leave as is", "required": false, "type": "string" }, { "name": "DisplayName", "in": "query", "description": "Update the DisplayName, if no value leave as is", "required": false, "type": "string" }, { "name": "Group", "in": "query", "description": "Update the GroupName, if no value leave as is", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Location/{Uid}": { "get": { "tags": [ "Location" ], "summary": "Returns a Point Of Interests", "operationId": "Location_PointOfInterest", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the location", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest]" } } } } }, "/api/v1.0/Location/Type/List": { "get": { "tags": [ "Location" ], "summary": "Returns a list of Point Of Interest Types", "operationId": "Location_PointOfInterestTypeList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestType[]]" } } } } }, "/api/v1.0/Location/Group/List": { "get": { "tags": [ "Location" ], "summary": "Returns a list of Point Of Interest Groups", "operationId": "Location_PointOfInterestGroupList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "PointOfInterestTypeUids", "in": "query", "description": "Comma separated list of Point Of Interest Type Uids, pass * for all", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestGroup[]]" } } } } }, "/api/v1.0/Location/EntryExitList": { "get": { "tags": [ "Location" ], "summary": "This will return a maximum of 500 entry or exit events for a PointOfInterest and unit combination", "operationId": "Location_PointOfInterestEntryExitList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "POIUids", "in": "query", "description": "Comma seperated list of Point Of Interest Uids. To return all enter *", "required": true, "type": "string" }, { "name": "PoiTypeUids", "in": "query", "description": "Comma seperated list of Point Of Interest Type Uids. To return all enter *", "required": true, "type": "string" }, { "name": "PoiGroupUids", "in": "query", "description": "Comma seperated list of Point Of Interest Group Uids. To return all enter *", "required": true, "type": "string" }, { "name": "UnitUids", "in": "query", "description": "Comma seperated list of Unit Uids. To return all enter *", "required": true, "type": "string" }, { "name": "NextRequestId", "in": "query", "description": "If used it will limit the results to updates that occured after this NextRequestId.\r\n Please use the NextRequestId from previous results to determine what to pass through.Pass 0 to start 7 days ago, blank to start 24 hours ago", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestEntryExitResult]" } } } } }, "/api/v1.0/Location/List": { "get": { "tags": [ "Location" ], "summary": "Returns a list of Point Of Interests", "operationId": "Location_PointOfInterestList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "PointOfInterestTypeUids", "in": "query", "description": "Comma separated list of Point Of Interest Type Uids, pass * for all", "required": true, "type": "string" }, { "name": "PointOfInterestGroupUids", "in": "query", "description": "Comma separated list of Point Of Interest Group Uids, pass * for all", "required": true, "type": "string" }, { "name": "LastUpdatedDateTimeUTC", "in": "query", "description": "This is UTC/GMT date. Format of dd MMM yyyy HH:mm:ss e.g: 20 October 2020 23:59:59", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest[]]" } } } } }, "/api/v1.0/Location/DeleteLocation": { "post": { "tags": [ "Location" ], "summary": "Delete Location.", "operationId": "Location_DeleteLocation", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "Point of Interest Uid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Location/UpdateByAddress": { "post": { "tags": [ "Location" ], "summary": "Update a location by Address.", "operationId": "Location_UpdateLocationByAddress", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "Location Uid", "required": true, "type": "string" }, { "name": "Name", "in": "query", "description": "Name of the location.", "required": true, "type": "string" }, { "name": "POIGroupUid", "in": "query", "description": "Uid of Group. If blank unassigned.", "required": true, "type": "string" }, { "name": "Diametre", "in": "query", "description": "The diametre in meters.", "required": true, "type": "number", "format": "double" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest]" } } } } }, "/api/v1.0/Location/CreateByAddress": { "post": { "tags": [ "Location" ], "summary": "Create a location by address.", "operationId": "Location_CreateLocationByAddress", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Name", "in": "query", "description": "Name of the location.", "required": true, "type": "string" }, { "name": "LocationTypeUid", "in": "query", "description": "Uid for Type of Location", "required": true, "type": "string" }, { "name": "POIGroupUid", "in": "query", "description": "Uid of Group.", "required": true, "type": "string" }, { "name": "Road", "in": "query", "description": "The road.", "required": true, "type": "string" }, { "name": "Suburb", "in": "query", "description": "The suburb.", "required": true, "type": "string" }, { "name": "Town", "in": "query", "description": "The town.", "required": true, "type": "string" }, { "name": "PostCode", "in": "query", "description": "The post code.", "required": true, "type": "string" }, { "name": "Province", "in": "query", "description": "The province.", "required": true, "type": "string" }, { "name": "Country", "in": "query", "description": "The country.", "required": true, "type": "string" }, { "name": "Diametre", "in": "query", "description": "The diametre in meters.", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest]" } } } } }, "/api/v1.0/Location/UpdateByCoordinates": { "post": { "tags": [ "Location" ], "summary": "Update a location by coordinates.", "operationId": "Location_UpdateLocationByCoordinates", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "Location Uid", "required": true, "type": "string" }, { "name": "Name", "in": "query", "description": "Name of the location.", "required": true, "type": "string" }, { "name": "POIGroupUid", "in": "query", "description": "Uid of Group. If blank unassigned.", "required": true, "type": "string" }, { "name": "Latitude", "in": "query", "description": "The latitude.", "required": true, "type": "number", "format": "double" }, { "name": "Longitude", "in": "query", "description": "The longitude.", "required": true, "type": "number", "format": "double" }, { "name": "Diametre", "in": "query", "description": "The diametre in meters.", "required": true, "type": "number", "format": "double" }, { "name": "Road", "in": "query", "description": "(Optional) The road.", "required": false, "type": "string" }, { "name": "Suburb", "in": "query", "description": "(Optional)The suburb.", "required": false, "type": "string" }, { "name": "Town", "in": "query", "description": "(Optional) The town.", "required": false, "type": "string" }, { "name": "PostCode", "in": "query", "description": "(Optional) The post code.", "required": false, "type": "string" }, { "name": "Province", "in": "query", "description": "(Optional) The province.", "required": false, "type": "string" }, { "name": "Country", "in": "query", "description": "(Optional) The country.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest]" } } } } }, "/api/v1.0/Location/CreateByCoordinates": { "post": { "tags": [ "Location" ], "summary": "Create a location by coordinates.", "operationId": "Location_CreateLocationByCoordinates", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Name", "in": "query", "description": "Name of the location.", "required": true, "type": "string" }, { "name": "LocationTypeUid", "in": "query", "description": "Uid for Type of Location", "required": true, "type": "string" }, { "name": "POIGroupUid", "in": "query", "description": "Uid of Group.", "required": true, "type": "string" }, { "name": "Latitude", "in": "query", "description": "The latitude.", "required": true, "type": "number", "format": "double" }, { "name": "Longitude", "in": "query", "description": "The longitude.", "required": true, "type": "number", "format": "double" }, { "name": "Diametre", "in": "query", "description": "The diametre in meters.", "required": true, "type": "number", "format": "double" }, { "name": "Road", "in": "query", "description": "(Optional) The road.", "required": false, "type": "string" }, { "name": "Suburb", "in": "query", "description": "(Optional)The suburb.", "required": false, "type": "string" }, { "name": "Town", "in": "query", "description": "(Optional) The town.", "required": false, "type": "string" }, { "name": "PostCode", "in": "query", "description": "(Optional) The post code.", "required": false, "type": "string" }, { "name": "Province", "in": "query", "description": "(Optional) The province.", "required": false, "type": "string" }, { "name": "Country", "in": "query", "description": "(Optional) The country.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest]" } } } } }, "/api/v1.0/Dispatch/Order/{Uid}/Get": { "get": { "tags": [ "Dispatch" ], "summary": "Returns information on a specific Order.", "operationId": "Order_Get", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order]" } } } } }, "/api/v1.0/Dispatch/Order/List": { "get": { "tags": [ "Dispatch" ], "summary": "Returns array of orders.", "operationId": "Order_List", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "CustomerUid", "in": "query", "description": "The Uid of the Customer", "required": false, "type": "string" }, { "name": "searchText", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order[]]" } } } } }, "/api/v1.0/Dispatch/Order/{Uid}/Delete": { "post": { "tags": [ "Dispatch" ], "summary": "Deletes the order", "operationId": "Order_OrderDelete", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Uid of the order.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Dispatch/Order/Create": { "post": { "tags": [ "Dispatch" ], "summary": "Create an Order", "operationId": "Order_OrderCreate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "orderRef", "in": "query", "description": "The external order reference.", "required": true, "type": "string" }, { "name": "autoComplete", "in": "query", "description": "Boolean True / False value", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.String]" } } } } }, "/api/v1.0/Dispatch/Order/{Uid}/Update": { "post": { "tags": [ "Dispatch" ], "summary": "Updates the order", "operationId": "Order_OrderUpdate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Uid of Order", "required": true, "type": "string" }, { "name": "orderRef", "in": "query", "description": "The external order reference.", "required": true, "type": "string" }, { "name": "autoComplete", "in": "query", "description": "Boolean True / False value", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Reports/ReportRunLogList": { "get": { "tags": [ "Report" ], "summary": "", "operationId": "Report_ReportRunLogList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem[]]" } } } } }, "/api/v1.0/Reports/ReportRunLogData": { "get": { "tags": [ "Report" ], "summary": "", "operationId": "Report_ReportRunLogData", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem]" } } } } }, "/api/v1.0/Dispatch/Stop/TypeList": { "get": { "tags": [ "Dispatch" ], "summary": "Returns list of available stop types", "operationId": "Stop_StopTypeList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopType[]]" } } } } }, "/api/v1.0/Dispatch/Stop/{Uid}/Get": { "get": { "tags": [ "Dispatch" ], "summary": "Returns a Stop", "operationId": "Stop_StopGet", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Stop Unique Id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop]" } } } } }, "/api/v1.0/Dispatch/Stop/StatusList": { "get": { "tags": [ "Dispatch" ], "summary": "Returns list of available stop statuses", "operationId": "Stop_StopStatusList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopStatus[]]" } } } } }, "/api/v1.0/Dispatch/Stop/List": { "get": { "tags": [ "Dispatch" ], "summary": "Returns array of stops for a customer.", "operationId": "Stop_StopList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "searchText", "in": "query", "description": "Text string to filter on StopRef, OrderRef", "required": false, "type": "string" }, { "name": "orderUid", "in": "query", "description": "Order Unique Id", "required": false, "type": "string" }, { "name": "stopStatusId", "in": "query", "description": "To filter by stop status id type in correct number value, to ignore filtering by stop status use 0", "required": false, "type": "integer", "format": "int32" }, { "name": "scheduledDateStart", "in": "query", "description": "Format of dd MMM yyyy e.g: 21 May 2013", "required": false, "type": "string" }, { "name": "scheduledDateEnd", "in": "query", "description": "Format of dd MMM yyyy e.g: 21 May 2013", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop[]]" } } } } }, "/api/v1.0/Dispatch/Stop/{uid}/Delete": { "post": { "tags": [ "Dispatch" ], "summary": "Deletes stop.", "operationId": "Stop_StopDelete", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "uid", "in": "path", "description": "Stop UniqueId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Dispatch/Stop/{uid}/UpdateStatus": { "post": { "tags": [ "Dispatch" ], "summary": "Update stop status, Only allows changes in stop status.", "description": "When status id = 3 current stop does not have unit and / or schedule time is blank\r\nWhen status id = 4 current stop does have unit and schedule time is not blank\r\nWhen status id = 5 current stop does have unit and schedule time is not blank", "operationId": "Stop_StopUpdateStatus", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "uid", "in": "path", "description": "Stop UniqueId", "required": true, "type": "string" }, { "name": "statusId", "in": "query", "description": "Int see method Stop/StatusList", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Dispatch/Stop/Create": { "post": { "tags": [ "Dispatch" ], "summary": "Creates a stop.", "operationId": "Stop_StopCreate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "orderUid", "in": "query", "description": "Order Unique Id", "required": true, "type": "string" }, { "name": "stopRef", "in": "query", "description": "The reference of the stop", "required": true, "type": "string" }, { "name": "locationUid", "in": "query", "description": "The Customer Location Code", "required": true, "type": "string" }, { "name": "duration", "in": "query", "description": "Time in minutes", "required": true, "type": "integer", "format": "int32" }, { "name": "stopTypeId", "in": "query", "description": "Int see method Dispatch/Stop/TypeList", "required": true, "type": "integer", "format": "int32" }, { "name": "scheduleDate", "in": "query", "description": "Please use a format of dd MMM yyyy e.g: 20 October 2020", "required": true, "type": "string" }, { "name": "scheduleTime", "in": "query", "description": "Please use a format of HH:mm:ss e.g: 23:59:59", "required": true, "type": "string" }, { "name": "unitUid", "in": "query", "description": "Unit UID See Mehtod Units/Unit/List", "required": true, "type": "string" }, { "name": "notes", "in": "query", "description": "Text notes about the stop", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.String]" } } } } }, "/api/v1.0/Dispatch/Stop/{uid}/Update": { "post": { "tags": [ "Dispatch" ], "summary": "Updates stop.", "operationId": "Stop_StopUpdate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "uid", "in": "path", "description": "Stop UniqueId", "required": true, "type": "string" }, { "name": "stopRef", "in": "query", "description": "The stops Reference", "required": true, "type": "string" }, { "name": "locationUid", "in": "query", "description": "Customer Location Unique Id", "required": true, "type": "string" }, { "name": "unitUid", "in": "query", "description": "Unit UID See Mehtod /Units/Unit/List", "required": true, "type": "string" }, { "name": "duration", "in": "query", "description": "Time in minutes. 0 for not relevant", "required": true, "type": "integer", "format": "int32" }, { "name": "stopTypeId", "in": "query", "description": "Int see method Stop/TypeList", "required": true, "type": "integer", "format": "int32" }, { "name": "statusId", "in": "query", "description": "Int see method Dispatch/Stop/List", "required": true, "type": "integer", "format": "int32" }, { "name": "notes", "in": "query", "description": "Text notes about the stop", "required": false, "type": "string" }, { "name": "scheduleDate", "in": "query", "description": "Please use a format of dd MMM yyyy e.g: 20 October 2020", "required": false, "type": "string" }, { "name": "scheduleTime", "in": "query", "description": "Please use a format of HH:mm:ss e.g: 23:59:59", "required": false, "type": "string" }, { "name": "arrivalStartDateTime", "in": "query", "description": "Please use a format of dd MMM yyyy HH:mm:ss e.g: 20 October 2020 23:59:59", "required": false, "type": "string" }, { "name": "arrivalEndDateTime", "in": "query", "description": "Please use a format of dd MMM yyyy HH:mm:ss e.g: 20 October 2020 23:59:59", "required": false, "type": "string" }, { "name": "completedDateTime", "in": "query", "description": "Please use a format of dd MMM yyyy HH:mm:ss e.g: 20 October 2020 23:59:59", "required": false, "type": "string" }, { "name": "completedDuration", "in": "query", "description": "Time in minutes. 0 for not relevant", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Units/{Uid}": { "get": { "tags": [ "Units" ], "summary": "This will return a single unit", "operationId": "Units_Get", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.Unit]" } } } } }, "/api/v1.0/Units/Tag/List": { "get": { "tags": [ "Units" ], "summary": "Returns an array of tags that can be associtaed with a unit", "operationId": "Units_TagList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Tag[]]" } } } } }, "/api/v1.0/Units/Unit/List": { "get": { "tags": [ "Units" ], "summary": "This will return a list of all units the user has access too", "operationId": "Units_List", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.Unit[]]" } } } } }, "/api/v1.0/Units/Group/List": { "get": { "tags": [ "Units" ], "summary": "This will return a list of unit groups the user has access too", "operationId": "Units_UnitGroupList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UnitGroupReturnEntities[]]" } } } } }, "/api/v1.0/Units/Journals/List": { "get": { "tags": [ "Units" ], "summary": "This will return all Jouranls in the system for Units", "operationId": "Units_JournalsList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Collections.Generic.List[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal]]" } } } } }, "/api/v1.0/Units/Tag/{Uid}/List": { "get": { "tags": [ "Units" ], "summary": "Returns an array of Units Associated with a Tag.", "operationId": "Units_TagUnitList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Tag Unique Id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.UnitListItem[]]" } } } } }, "/api/v1.0/Units/{Uid}/Tag/List": { "get": { "tags": [ "Units" ], "summary": "Returns and array of tags associated with the unit", "operationId": "Units_UnitTagList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "UniqueId of the Unit", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Tag[]]" } } } } }, "/api/v1.0/Units/{Uid}/Journals/List": { "get": { "tags": [ "Units" ], "summary": "This will return all journals for a unit", "operationId": "Units_UnitJournalList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Collections.Generic.List[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal]]" } } } } }, "/api/v1.0/Units/{Uid}/Journals/{JournalUid}/EntriesList": { "get": { "tags": [ "Units" ], "summary": "This will return all journal entries for a journal", "operationId": "Units_UnitJournalEntriesList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit to fetch", "required": true, "type": "string" }, { "name": "JournalUid", "in": "path", "description": "The Unique ID of the journal to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Collections.Generic.List[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.JournalEntry]]" } } } } }, "/api/v1.0/Units/Unit/Fuellog/List": { "get": { "tags": [ "Units" ], "summary": "This will return a list of fuel logs", "operationId": "Units_FuelLogList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "UID", "in": "query", "description": "(Optional) This is the unique ID of the Unit. Empty or * selects all units.", "required": false, "type": "string" }, { "name": "StartDate", "in": "query", "description": "(Optional) This is UTC/GMT date. Please use a format of dd MMM yyyy HH:mm:ss e.g: 01 May 2023 18:14:56.", "required": false, "type": "string" }, { "name": "EndDate", "in": "query", "description": "(Optional) This is UTC/GMT date. Please use a format of dd MMM yyyy HH:mm:ss e.g: 31 May 2023 18:14:56.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem[]]" } } } } }, "/api/v1.0/Units/{Uid}/PositionAtTime": { "get": { "tags": [ "Units" ], "summary": "", "operationId": "Units_PositionAtTime", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit to fetch", "required": true, "type": "string" }, { "name": "PointInTimeDateTimeUTC", "in": "query", "description": "This is UTC/GMT date. \r\n Please use a format of dd MMM yyyy HH:mm:ss e.g: 21 May 2013 18:14:56.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Unit]" } } } } }, "/api/v1.0/Units/LatestPositionsList": { "get": { "tags": [ "Units" ], "summary": "This will return all the units lastest positions that the user calling it has access to.", "operationId": "Units_LatestPositionsList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "LastDateReceivedUtc", "in": "query", "description": "(Optional) If used it will limit the results to updates that occured after this date. \r\n This is UTC/GMT date. \r\n Please use a format of dd MMM yyyy HH:mm:ss e.g: 21 May 2013 18:14:56. \r\n Please use the max dateUtc from previous results to determine what to pass through.\r\n This is so we do not constantly send the same information over the wire.", "required": false, "type": "string" }, { "name": "UnitUid", "in": "query", "description": "Single unit UID filter. Empty or * selects all units", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Unit[]]" } } } } }, "/api/v1.0/Units/Tag/{Uid}/Delete": { "post": { "tags": [ "Units" ], "summary": "Delete a Unit Tag. This will remove the tag from all Units it is associated with.", "operationId": "Units_UnitTagDelete", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Tag Unique Id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Units/{Uid}/Tags/Update": { "post": { "tags": [ "Units" ], "summary": "Update the Units associated tags by sending a list of tags.", "operationId": "Units_UpdateUnitTags", "consumes": [ "application/json", "text/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Unit Unique Id", "required": true, "type": "string" }, { "name": "Tags", "in": "body", "description": "List of tags. Send all Tags that need to be associated. Items left out will be removed.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Tag" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Units/Tag/Create": { "post": { "tags": [ "Units" ], "summary": "Create a new unit tag.", "operationId": "Units_UnitTagCreate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Name", "in": "query", "description": "Name of the tag", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Tag]" } } } } }, "/api/v1.0/Units/{Uid}/UnitNameInfo/Update": { "post": { "tags": [ "Units" ], "summary": "Update the Units Name and Information", "operationId": "Units_UnitNameInfoUpdate", "consumes": [ "application/json", "text/json" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "This is a Guid that expires after 24 hours and gets allocated by AuthenticationManager", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit to fetch", "required": true, "type": "string" }, { "name": "Model", "in": "body", "description": "UnitNameInformationUpdateModel - UnitName: Max 50 Characters, Information: (Remove property to exclude in update, include property and provide value/blank value to update/clear field ) Max 1000 Characters", "required": true, "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.UnitUpdateEntities.UnitNameInformationUpdateModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Units/Units/{Uid}/Fuellog/Delete": { "post": { "tags": [ "Units" ], "summary": "This will delete a Fuel Log", "operationId": "Units_FuellogDelete", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "(Required) This is the unique ID of the Fuel log you want to delete.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Units/Journals/Create": { "post": { "tags": [ "Units" ], "summary": "Create a journal for all units in the system", "operationId": "Units_CreateJournal", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Name", "in": "query", "description": "The Name of the journal", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal]" } } } } }, "/api/v1.0/Units/Tag/{Uid}/Update": { "post": { "tags": [ "Units" ], "summary": "Update the name of a unit tag.", "operationId": "Units_UnitTagUpdate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "Tag Unique Id", "required": true, "type": "string" }, { "name": "Name", "in": "query", "description": "Name of the Tag", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Units/{Uid}/Journals/Create": { "post": { "tags": [ "Units" ], "summary": "Create a journal for a unit", "operationId": "Units_CreateUnitJournal", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit", "required": true, "type": "string" }, { "name": "Name", "in": "query", "description": "The Name of the journal", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal]" } } } } }, "/api/v1.0/Units/{Uid}/GroupName/Update": { "post": { "tags": [ "Units" ], "summary": "This will update a Units Group Name", "operationId": "Units_UnitGroupNameUpdate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "(Required) The Unique ID of the unit.", "required": true, "type": "string" }, { "name": "GroupUid", "in": "query", "description": "(Required) GroupUid.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]" } } } } }, "/api/v1.0/Units/{Uid}/Journals/{JournalUid}/CreateEntry": { "post": { "tags": [ "Units" ], "summary": "Create a Journal Entry in a journal for a unit", "operationId": "Units_CreateUnitJournalEntry", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "Uid", "in": "path", "description": "The Unique ID of the unit", "required": true, "type": "string" }, { "name": "JournalUid", "in": "path", "description": "The Unique ID of the Journal", "required": true, "type": "string" }, { "name": "Title", "in": "query", "description": "The Name of the journal entry", "required": true, "type": "string" }, { "name": "DateTime", "in": "query", "description": "The Date of the journal entry. This is the local date of the user. Format of dd MMM yyyy HH:mm:ss e.g: 20 October 2020 23:59:59", "required": true, "type": "string" }, { "name": "Cost", "in": "query", "description": "Cost of the journal entry", "required": true, "type": "number", "format": "double" }, { "name": "Text", "in": "query", "description": "Text body of the journal entry", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" } } } } }, "/api/v1.0/Units/{UnitUid}/Fuellog/Create": { "post": { "tags": [ "Units" ], "summary": "This will create a new Fuel Log", "operationId": "Units_FuelLogCreate", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "UnitUid", "in": "path", "description": "(Required) This is the unique ID of the Unit.", "required": true, "type": "string" }, { "name": "Fuel", "in": "query", "description": "(Required) This is the litres/gallons of fuel.", "required": true, "type": "number", "format": "double" }, { "name": "DateTime", "in": "query", "description": "(Required) Date fuel was purchased. Please use a format of dd MMM yyyy HH:mm:ss e.g: 21 May 2013 18:14:56", "required": true, "type": "string", "format": "date-time" }, { "name": "DriverID", "in": "query", "description": "(Optional) This is the unique ID of the Driver.", "required": false, "type": "string" }, { "name": "Odometer", "in": "query", "description": "(Optional) Odometer reading at time of fuel purchase.", "required": false, "type": "number", "format": "double" }, { "name": "FuelType", "in": "query", "description": "(Optional) Type of Fuel – Please specify Petrol, Diesel or AdBlue.", "required": false, "type": "string" }, { "name": "CostperFuelVolume", "in": "query", "description": "(Optional) Cost per litre of fuel.", "required": false, "type": "number", "format": "double" }, { "name": "TotalCost", "in": "query", "description": "(Optional) Total cost of fuel purchased.", "required": false, "type": "number", "format": "double" }, { "name": "EngineReading", "in": "query", "description": "(Optional) Engine Reading hours at time of fuel purchase / fill up.", "required": false, "type": "number", "format": "double" }, { "name": "Reference", "in": "query", "description": "(Optional) Fuel log reference.", "required": false, "type": "string" }, { "name": "Notes", "in": "query", "description": "(Optional) Fuel log notes.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem]" } } } } }, "/api/v1.0/User/TemporaryUserList": { "get": { "tags": [ "User" ], "summary": "USer List", "operationId": "User_UserList", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser[]]" } } } } }, "/api/v1.0/User/CreateTemporaryUser": { "post": { "tags": [ "User" ], "summary": "Create a temporary User", "operationId": "User_CreateTempUser", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "UserIdGuid", "in": "query", "description": "(Required) User Guid obtained from AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "SessionId", "in": "query", "description": "(Required) This is a Guid that expires after 24 and gets allocated by AuthenticationManager.", "required": true, "type": "string", "format": "uuid" }, { "name": "DisplayName", "in": "query", "description": "(Required) Display name of Temporary user.", "required": true, "type": "string" }, { "name": "AccessStartDate", "in": "query", "description": "(Required) This is UTC/GMT date. Please use a format of dd MMM yyyy HH:mm:ss E.g., 17 Nov 2022 18:14:56.", "required": true, "type": "string" }, { "name": "AutoExpiryDate", "in": "query", "description": "(Required) This is UTC/GMT date. Please use a format of dd MMM yyyy HH:mm:ss E.g., 17 Nov 2022 18:14:56.", "required": true, "type": "string" }, { "name": "EmailTo", "in": "query", "description": "(Required) – Comma separated string of temporary user email addresses. Minimum of one email address required.", "required": true, "type": "string" }, { "name": "UnitUids", "in": "query", "description": "(Required) Comma separated string of UnitUIDs of units. Minimum of at least one UnitUID must be provided.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser]" } } } } } }, "definitions": { "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertTypeListItem[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertTypeListItem" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.Status": { "type": "object", "properties": { "Result": { "type": "string" }, "ErrorCode": { "type": "string" }, "Message": { "type": "string" } } }, "ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertTypeListItem": { "type": "object", "properties": { "UID": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertListResult]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertListResult" } } }, "ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertListResult": { "type": "object", "properties": { "AlertsList": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertListItem" } }, "StartUID": { "type": "string" } } }, "ThreedTracking.Client.Data.EntitiesV2.AlertReturnEntities.AlertListItem": { "type": "object", "properties": { "AlertUID": { "type": "string" }, "AlertName": { "type": "string" }, "AlertType": { "type": "string" }, "AlertTypeUID": { "type": "string" }, "Vehicle": { "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "AlertMessage": { "type": "string" }, "AlertQueueId": { "format": "int64", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Code.ErrorCode[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Code.ErrorCode" } } } }, "ThreedTracking.Client.Code.ErrorCode": { "type": "object", "properties": { "Number": { "format": "int32", "type": "integer" }, "Code": { "type": "string" }, "Description": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UserSessionToken]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.UserSessionToken" } } }, "ThreedTracking.API.ServiceLibrary.Entities.UserSessionToken": { "type": "object", "properties": { "UserIdGuid": { "type": "string" }, "SessionId": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Boolean]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "boolean" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer": { "type": "object", "properties": { "Uid": { "type": "string" }, "ExternalCustomerCode": { "type": "string" }, "Name": { "type": "string" }, "OpenStopCount": { "format": "int32", "type": "integer" }, "UnscheduledStopCount": { "format": "int32", "type": "integer" }, "LocationCount": { "format": "int32", "type": "integer" }, "AdditionalDetails": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.AdditionalDetails" } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.AdditionalDetails": { "type": "object", "properties": { "Attribute": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Attribute" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Attribute": { "type": "object", "properties": { "Name": { "type": "string" }, "Group": { "type": "string" }, "Value": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Customer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation": { "type": "object", "properties": { "Uid": { "type": "string" }, "ExternalCustomerLocationCode": { "type": "string" }, "Name": { "type": "string" }, "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "Road": { "type": "string" }, "Suburb": { "type": "string" }, "Town": { "type": "string" }, "PostCode": { "type": "string" }, "Province": { "type": "string" }, "Country": { "type": "string" }, "CustomerLocationStatusId": { "format": "int32", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocationStatus[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocationStatus" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocationStatus": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.CustomerLocation" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.AddressCoordinate[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.AddressCoordinate" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.AddressCoordinate": { "type": "object", "properties": { "Coordinate": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Coordinate" }, "Address": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Address" }, "Rank": { "format": "double", "type": "number" } } }, "ThreedTracking.API.ServiceLibrary.Entities.Coordinate": { "type": "object", "properties": { "Identifier": { "format": "int64", "type": "integer" }, "Longitude": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" } } }, "ThreedTracking.API.ServiceLibrary.Entities.Address": { "type": "object", "properties": { "Identifier": { "format": "int64", "type": "integer" }, "AddressId": { "format": "int32", "type": "integer" }, "Number": { "type": "string" }, "Road": { "type": "string" }, "Town": { "type": "string" }, "District": { "type": "string" }, "PostCode": { "type": "string" }, "CountryISO": { "type": "string" }, "Suburb": { "type": "string" }, "Province": { "type": "string" }, "TownDistanceMeters": { "format": "double", "type": "number" }, "RoadDistanceMeters": { "format": "double", "type": "number" }, "Latititude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.SensorReadingList]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.SensorReadingList" } } }, "ThreedTracking.API.ServiceLibrary.Entities.SensorReadingList": { "type": "object", "properties": { "SensorReadings": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.SensorReading" } }, "StartId": { "format": "int64", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.SensorReading": { "type": "object", "properties": { "UnitUid": { "type": "string" }, "Name": { "type": "string" }, "Value": { "type": "string" }, "MeasurementSign": { "type": "string" }, "ReadingTimeLocal": { "format": "date-time", "type": "string" }, "ReadingTimeUtc": { "format": "date-time", "type": "string" }, "ServerTimeUtc": { "format": "date-time", "type": "string" }, "SensorType": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PositionList]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PositionList" } } }, "ThreedTracking.API.ServiceLibrary.Entities.PositionList": { "type": "object", "properties": { "Position": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Position" } }, "StartId": { "format": "int64", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.Position": { "type": "object", "properties": { "Unit": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Unit" }, "Latitude": { "format": "float", "type": "number" }, "Longitude": { "format": "float", "type": "number" }, "Address": { "type": "string" }, "Speed": { "format": "float", "type": "number" }, "SpeedMeasure": { "type": "string" }, "Heading": { "format": "float", "type": "number" }, "Ignition": { "type": "string" }, "Odometer": { "format": "float", "type": "number" }, "EngineTime": { "format": "float", "type": "number" }, "EngineStatus": { "type": "string" }, "ServerTimeUTC": { "format": "date-time", "type": "string" }, "GPSTimeLocal": { "format": "date-time", "type": "string" }, "GPSTimeUtc": { "format": "date-time", "type": "string" }, "Driver": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Driver" }, "PointOfInterest": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PositionPointOfInterest" }, "InputOutputs": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.InputOutput" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.Unit": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" }, "Imei": { "type": "string" }, "CompanyUid": { "type": "string" }, "LastReportedTimeLocal": { "format": "date-time", "type": "string" }, "LastReportedTimeUTC": { "format": "date-time", "type": "string" }, "Position": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Position" }, "SensorReadings": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.SensorReading" } }, "Assets": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.AssetItem" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.Driver": { "type": "object", "properties": { "Uid": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Code": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.PositionPointOfInterest": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.InputOutput": { "type": "object", "properties": { "SystemName": { "type": "string" }, "Description": { "type": "string" }, "UserDescription": { "type": "string" }, "Active": { "type": "boolean" } } }, "ThreedTracking.API.ServiceLibrary.Entities.AssetItem": { "type": "object", "properties": { "AssetName": { "type": "string" }, "AssetType": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverListItem[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverListItem" } } } }, "ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverListItem": { "type": "object", "properties": { "Uid": { "type": "string" }, "DriverID": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "DisplayName": { "type": "string" }, "GroupUid": { "type": "string" }, "GroupName": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.Driver]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.Driver" } } }, "ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.Driver": { "type": "object", "properties": { "Uid": { "type": "string" }, "DriverID": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "DisplayName": { "type": "string" }, "GroupUid": { "type": "string" }, "GroupName": { "type": "string" }, "Tags": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverTag" } } } }, "ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverTag": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverTag[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverTag" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverAddResult]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverAddResult" } } }, "ThreedTracking.Client.Data.EntitiesV2.DriverReturnEntities.DriverAddResult": { "type": "object", "properties": { "Uid": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest" } } }, "ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" }, "Type": { "type": "string" }, "POIGroupUid": { "type": "string" }, "POIGroupName": { "type": "string" }, "Diametre": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "WKT": { "type": "string" }, "ShapeType": { "type": "string" }, "POITypeUid": { "type": "string" }, "LastUpdatedDateUTC": { "format": "date-time", "type": "string" }, "Address": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestType[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestType" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestType": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestGroup[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestGroup" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestGroup": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" }, "PointOfInterestTypeUid": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestEntryExitResult]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestEntryExitResult" } } }, "ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestEntryExitResult": { "type": "object", "properties": { "PointOfInterestEntryExitList": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestEntryExit" } }, "NextRequestId": { "format": "int64", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.PointOfInterestEntryExit": { "type": "object", "properties": { "POIUid": { "type": "string" }, "PointOfInterestName": { "type": "string" }, "UnitName": { "type": "string" }, "UnitUid": { "type": "string" }, "LocalDate": { "format": "date-time", "type": "string" }, "Type": { "type": "string" }, "Driver": { "type": "string" }, "DriverCode": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.PointOfInterest" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order" } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order": { "type": "object", "properties": { "Uid": { "type": "string" }, "OrderRef": { "type": "string" }, "OrderIdentifier": { "type": "string" }, "AutoComplete": { "type": "boolean" }, "OrderStatus": { "type": "string" }, "UnscheduledStops": { "format": "int32", "type": "integer" }, "OpenStops": { "format": "int32", "type": "integer" }, "CompletedStops": { "format": "int32", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Order" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.String]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem": { "type": "object", "properties": { "ReportRunLogUid": { "type": "string" }, "ScheduleName": { "type": "string" }, "ScheduleType": { "type": "string" }, "ReportType": { "type": "string" }, "RunDate": { "format": "date-time", "type": "string" }, "Results": { "type": "object" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.ReportEntities.ReportRunLogItem" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopType[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopType" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopType": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop" } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop": { "type": "object", "properties": { "Uid": { "type": "string" }, "StopRef": { "type": "string" }, "OrderRef": { "type": "string" }, "OrderIdentifier": { "type": "string" }, "OrderUid": { "type": "string" }, "LocationName": { "type": "string" }, "ExternalCustomerLocationCode": { "type": "string" }, "LocationUid": { "type": "string" }, "UnitName": { "type": "string" }, "UnitUid": { "type": "string" }, "ScheduledDate": { "format": "date-time", "type": "string" }, "ArrivalStartDate": { "format": "date-time", "type": "string" }, "ArrivalEndDate": { "format": "date-time", "type": "string" }, "Duration": { "format": "int32", "type": "integer" }, "StopType": { "type": "string" }, "StopTypeId": { "format": "int32", "type": "integer" }, "StopStatus": { "type": "string" }, "StopStatusId": { "format": "int32", "type": "integer" }, "Notes": { "type": "string" }, "CompletedDate": { "format": "date-time", "type": "string" }, "StartedDate": { "format": "date-time", "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopStatus[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopStatus" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.StopStatus": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.OrderReturnEntities.Stop" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.Unit]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.Unit" } } }, "ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.Unit": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" }, "IMEI": { "type": "string" }, "Status": { "type": "string" }, "GroupName": { "type": "string" }, "CompanyName": { "type": "string" }, "CompanyUid": { "type": "string" }, "PhoneNumber": { "type": "string" }, "UnitType": { "type": "string" }, "Information": { "type": "string" }, "CreatedDateTimeUtc": { "format": "date-time", "type": "string" }, "DriverUid": { "type": "string" }, "AdditionalDetails": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.AdditionalDetails" }, "PartnerCustomInfo": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.AdditionalDetails" } } }, "ThreedTracking.API.ServiceLibrary.Entities.SingleUnitReturnEntities.AdditionalDetails": { "type": "object", "properties": { "Attributes": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Attribute" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.Attribute": { "type": "object", "properties": { "AttributeId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Group": { "type": "string" }, "DataType": { "type": "string" }, "Value": { "type": "string" }, "LastUpdatedBy": { "type": "string" }, "LastUpdatedDate": { "format": "date-time", "type": "string" }, "RecurringDatePart": { "type": "string" }, "RecurringNumber": { "format": "int64", "type": "integer" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Tag[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Tag" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.Tag": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.Unit[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.Unit" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.Unit": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" }, "IMEI": { "type": "string" }, "Status": { "type": "string" }, "GroupName": { "type": "string" }, "CompanyName": { "type": "string" }, "CompanyUid": { "type": "string" }, "PhoneNumber": { "type": "string" }, "UnitType": { "type": "string" }, "CreatedDateTimeUtc": { "format": "date-time", "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UnitGroupReturnEntities[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UnitGroupReturnEntities" } } } }, "ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UnitGroupReturnEntities": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Collections.Generic.List[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" }, "UnitUid": { "type": "string" }, "TotalCost": { "format": "double", "type": "number" }, "AdditionalDetails": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.AdditionalDetails" } } }, "ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.AdditionalDetails": { "type": "object", "properties": { "Attributes": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Attribute" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.UnitListItem[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.UnitListItem" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.UnitListReturnEntities.UnitListItem": { "type": "object", "properties": { "Uid": { "type": "string" }, "Name": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[System.Collections.Generic.List[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.JournalEntry]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.JournalEntry" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.JournalEntry": { "type": "object", "properties": { "JournalUid": { "type": "string" }, "JournalEntryUid": { "type": "string" }, "Title": { "type": "string" }, "Cost": { "format": "double", "type": "number" }, "DateTime": { "format": "date-time", "type": "string" }, "Text": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem" } } } }, "ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem": { "type": "object", "properties": { "UID": { "type": "string" }, "UnitUID": { "type": "string" }, "DriverID": { "type": "string" }, "FuelDateTime": { "format": "date-time", "type": "string" }, "Fuel": { "type": "string" }, "VolumeType": { "type": "string" }, "Odometer": { "type": "string" }, "FuelLogCreatedDate": { "format": "date-time", "type": "string" }, "FuelType": { "type": "string" }, "CostPerVolume": { "type": "string" }, "TotalCost": { "type": "string" }, "EngineReading": { "type": "string" }, "Reference": { "type": "string" }, "Notes": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Unit]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Unit" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Unit[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Unit" } } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.Tag]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Tag" } } }, "ThreedTracking.API.ServiceLibrary.Entities.UnitUpdateEntities.UnitNameInformationUpdateModel": { "type": "object", "properties": { "UnitName": { "type": "string" }, "Information": { "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.JournalReturnEntities.Journal" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.FuelLogReturnEntities.FuelLogItem" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser[]]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "type": "array", "items": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser" } } } }, "ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser": { "type": "object", "properties": { "UserUid": { "type": "string" }, "DisplayName": { "type": "string" }, "CreatedDateTimeUtc": { "format": "date-time", "type": "string" }, "AccessStartDateUtc": { "format": "date-time", "type": "string" }, "AutoExpiryDateUtc": { "format": "date-time", "type": "string" } } }, "ThreedTracking.API.ServiceLibrary.Entities.ResultObject[ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser]": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/ThreedTracking.API.ServiceLibrary.Entities.Status" }, "Result": { "$ref": "#/definitions/ThreedTracking.Client.Data.EntitiesV2.ApiEntities.UserReturnEntities.TempUser" } } } } }