#%RAML 0.8 title: Shipment Tracker API baseUri: "https://api.us1.covisint.com/shipmenttracker/v1" protocols: [HTTPS] schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } , "required":[ "id" ] } - namedResourceReference: | { "id" : "http://api.covisint.com/schema/namedScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the basic resource reference and adds internationalized name and description.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceReference#" }, "properties" : { "name" : { "description": "Internationalized resource name.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized resource description.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - resourceV2: | { "id" : "http://api.covisint.com/schema/resourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resourceV2", "type" : "object", "description" : "A basic resource (version V2).", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - realmScopedResourceV2: | { "id" : "http://api.covisint.com/schema/realmScopedResourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - errorResponseSchema: | { "id" : "http://api.covisint.com/schema/errorResponseSchema", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of an HTTP 4xx/5xx error response.", "properties" : { "status" : { "type" : "number", "minimum" : 400, "maximum" : 599, "description" : "The HTTP status code." }, "apiMessage" : { "type" : "string", "description" : "A helpful, human-readable description of the error, useful for basic diagnostics." }, "apiStatusCode" : { "type" : "string", "description" : "The API-specific status code." } } , "required":[ "status" ] } - serviceCode: | { "id" : "http://api.covisint.com/schema/serviceCodes", "$schema" : "http://json-schema.org/draft-04/schema", "type": "object", "description": "The site/service/location codes granted along with a service.", "properties": { "code": { "type": "string", "maxLength": 200, "description": "The code value." }, "codeKind": { "type": "string", "maxLength": 36, "description": "The associated business unit." } } , "required":[ "code", "codeKind" ] } - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: | { "id" : "http://api.covisint.com/idm/schema/phone", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for phone number details.", "properties" : { "number" : { "type" : "string","maxLength" : 100, "description" : "The phone number." }, "type" : { "enum" : [ "main", "mobile", "fax" ], "description" : "The phone number type." } }, "required" : [ "type" ] } - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.", "extends": { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The application name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The application description (internationalized).", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "properties":{ "type":"array", "description":"Properties used by the implementation.", "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The name of the property." }, { "type": "string", "description": "The value of the property." } ] } ] } , "required":[ "items" ] } , "required":[ "name" ] } - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } , "required":[ "type" ] } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ] } } , "required":[ "type" ] } - dataType: | { "id" : "http://api.covisint.com/schema/dataType", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Data type enum.", "enum":[ "string", "integer", "bool", "decimal" ] } - attribute: | { "id" : "http://api.covisint.com/schema/attribute", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "An attribute.", "properties" : { "oneOf" : [ { "attributeTypeId" : { "type" : "string", "description" : "The attribute type id." } }, { "attributeType" : { "description" : "The full attribute type definition.", "$ref" : "http://api.covisint.com/schema/attributeType#" } } ], "value" : { "type" : "any", "description" : "The attribute value." } } , "required":[ "attributeTypeId" ] } - attributes: | { "id" : "http://api.covisint.com/schema/attributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of attributes.", "items" : { "$ref" : "http://api.covisint.com/schema/attribute#" } } - expression: | { "id" : "http://api.covisint.com/schema/expression#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The DSL for defining conditional expressions.", "oneOf" : [ { "type" : "object", "properties" : { "any" : { "type" : "array", "description" : "An aggregate expression representing an 'any' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "properties" : { "all" : { "type" : "array", "description" : "An aggregate expression representing an 'all' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "description" : "A simple leaf-node expression. The format of this expression is: '(f:, v:())'. The supported expressions are: equal, notEqual, startsWith, endsWith, matches, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. The field name can be a simple field name i.e. 'id' or hierarchical field name using dot-notation like 'resource.id' / 'resource.tag[0]' . The value corresponding to the field name provided should always be a simple data type and cannot be an array or an object.", "properties" : { "expr" : { "type" : "string" } } , "required":[ "expr" ] } ] } - shipmentRoutes: | { "id": "http://api.covisint.com/schema/shipmentRoutes", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of shipment routes.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/shipmentRoute#" } } - shipmentConnectorResponse: | { "id": "http://api.covisint.com/schema/shipmentConnectorResponse", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of shipmentConnectorResponse.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/shipmentConnectorResponse#" }, "headerColumns" :{ "type":"Object", "description":"Object headers, where we will have field mapping." }, "rows" : { "type":"Object", "description":"Rows, map of strings." } } - shipmentRoute: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/shipmentRoute", "type": "object", "description": "Schema representing a shipment route.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The shipment route name (internationalized).", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/internationalString#" } }, "description": { "description": "The shipment route description (internationalized).", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/internationalString#" } }, "active" :{ "type":"boolean", "description":"The state of the shipment route. By default a route is always active.", "default" : true }, "tags" : { "description" : "The list of tags associated with the shipment route.", "$ref" : "http://api.covisint.com/schema/tags#", "readOnly" : true }, "originLocation": { "description": "The shipment route's origin location", "$ref": "http://api.covisint.com/schema/location#" }, "destinationLocation": { "description": "The shipment route's destination location", "$ref": "http://api.covisint.com/schema/location#" }, "intermediateLocations": { "description": "Collection of all the shipment route's intermediate locations", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/location#" } } }, "required": ["name","originLocation","destinationLocation"] } - deviceViolations: | { "id": "http://api.covisint.com/schema/deviceViolations", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of device violations.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/deviceViolation#" } } - deviceViolation: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/deviceViolation", "type": "object", "description": "Schema representing a device violation.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "violatedDeviceId": { "description": "The violated device id .", "type": "string" }, "violatedAttributeValue": { "description": "The violated device attribute value .", "type": "string" }, "violatedDeviceState": { "description": "The violated device state .", "type": "string" }, "violatedAttributeName": { "description": "The shipment violated device attibute name .", "type": "string" }, "violationMessage": { "description": "The violation message .", "type": "string" }, "triggeredRuleId": { "description": "Triggered rule Id .", "type": "string" } }, "required": ["violatedDevice","violatedAttributeValue","violatedDeviceState","violatedAttributeName","violationMessage"] } - attributeConfigurations: | { "id": "http://api.covisint.com/schema/attributeConfigurations", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of attribute Configurations.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/attributeConfiguration#" } } - attributeConfiguration: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/attributeConfiguration", "type": "object", "description": "Schema representing an attribute Configuration.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "deviceId": { "description": " device id .", "type": "string" }, "attributeId": { "description": "Id of the attribute", "type": "string" }, "attributeName": { "description": "Attribute name", "type": "string" }, "attributeUnit": { "description": "Attribute unit", "type": "string" }, "attributeImage": { "description": "The attribute image.", "type": "string" } }, "required": ["deviceId","attributeId","attributeUnit","attributeImage"] } - shipmenthealth: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/deviceViolation", "type": "object", "description": "Schema representing a device violation.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "shipmentHealthStatus": { "description": "shipment Health Status.", "type": "number" }, "trackingDevice" :{ "type":"object", "description":"The tracking device atached to container.", "properties":{ "trackingDeviceId":{ "type":"string", "description":"Id of the tracking device" }, "violatedAttributeValue":{ "type":"number", "description":"violated Attribute Value" }, "violatedDeviceState":{ "type":"number", "description":"Violated device state" }, "violatedAttributeName":{ "type":"string", "description":"violated Attribute Name" }, "violationMessage":{ "type":"string", "description":"violation Message" } } }, "shipmentContainers" :{ "type":"object", "description":" Shipment container attched to the shipmentTracker", "properties":{ "id":{ "type":"string", "description":"UUID of the shipment container" }, "trackingDevice" :{ "type":"object", "description":"The tracking device atached to container.", "properties":{ "trackingDeviceId":{ "type":"string", "description":"Id of the tracking device" }, "violatedAttributeValue":{ "type":"number", "description":"violated Attribute Value" }, "violatedDeviceState":{ "type":"number", "description":"Violated device state" }, "violatedAttributeName":{ "type":"string", "description":"violated Attribute Name" }, "violationMessage":{ "type":"string", "description":"violation Message" } } } } } } } - deviceSyncs: | { "id": "http://api.covisint.com/schema/deviceSyncs", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of device syncs.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/devicesync#" } } - deviceSync: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/devicesync", "type": "object", "description": "Schema representing a device sync.", "properties": { "shipmentDeviceId": { "description": "The shipment device id .", "type": "string" }, "latitude": { "description": "Current latitude of device .", "type": "number" }, "longitude": { "description": "Current longitude of device.", "type": "number" }, "battery_level": { "description": "Battery level of device .", "type": "number" }, "signal_strength": { "description": "sihnal strength of device .", "type": "string" } } } - shipmenttrackers: | { "id": "http://api.covisint.com/schema/shipmenttracker", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of shipmenttrackers.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/shipmenttracker#" } } - shipmenttracker: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/shipmenttracker", "type": "object", "description": "Schema representing a shipmenttracker.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "shipmentNumber" :{ "type":"string", "description":"Shipment Number." }, "shipmentId" :{ "type":"string", "description":"ShipmentId." }, "shipmentRouteId" :{ "type":"string", "description":"Shipment route Id." }, "shipmentDestination" :{ "type":"string", "description":"Shipment destination." }, "shipmentSource" :{ "type":"string", "description":"Shipment source." }, "shipmentDeviceId" :{ "type":"string", "description":"DeviceId of the shipment." }, "shipmentTrackingStatus" :{ "type":"integer", "description":"Shipment tarcking status" }, "shipmentHealthStatus" :{ "type":"integer", "description":"Shipment health status." }, "shipmentArrivalDate" :{ "type":"object", "description":"The estimated shipment arrival date." }, "totalPackageQuantity" :{ "type":"integer", "description":"Total package quantity." }, "trackingDevice" :{ "type":"object", "description":"Attached tracking device.", "properties":{ "name":{ "description": "Name of the tracking device.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "trackingDeviceId":{ "type":"string", "description":"Id of the tracking device" }, "latitude":{ "type":"number", "description":"Latitude tracking device" }, "longitude":{ "type":"number", "description":"Longitude of the tracking device" }, "standaradAttributes":{ "type":"object", "description":"Standarad attributes attached to this tracking device" }, "attributeConfiguration":{ "type":"object", "description":"Configuration of the attributes " } } }, "shipmentContainers" : { "type":"object", "description":" Shipment container attched to the shipmentTracker", "properties":{ "id":{ "type":"string", "description":"UUID of the shipment container" }, "containerId":{ "type":"string", "description":"Container ID of the shipment container" }, "parentContainerId":{ "type":"string", "description":"Parent Container ID " }, "packageLevel":{ "type":"string", "description":"package level of the container" }, "packageType":{ "type":"string", "description":"PackageType of the shipment container" }, "packagedQuantity":{ "type":"integer", "description":"PackagedQuantity of the shipment container" }, "SSSCCode":{ "type":"string", "description":"SSSCCode of the shipment container" }, "orderLineId":{ "type":"integer", "description":"Order Line Id of the shipment container" }, "orderNumber":{ "type":"integer", "description":"Order Number of the shipment container" }, "itemDescription":{ "type":"string", "description":"Item Description of the shipment container" }, "containerDeviceId":{ "type":"string", "description":"Container Device Id of the shipment container" }, "trackingDevice" :{ "type":"object", "description":"The tracking device atached o container.", "properties":{ "name":{ "description": "Name of the notification.", "$ref": "http://api.covisint.com/idm/schema/internationalString#" }, "trackingDeviceId":{ "type":"string", "description":"Id of the tracking device" }, "latitude":{ "type":"number", "description":"Latitude of the tracking device" }, "longitude":{ "type":"number", "description":"Longitude of the tracking device" }, "standaradAttributes":{ "type":"object", "description":"Standarad attributes attached to this tracking device" }, "attributeConfiguration":{ "type":"object", "description":"Configuration of the attributes " } } } }, "required": ["containerId", "packageType", "parentContainerId", "packageLevel" , "packagedQuantity" ,"SSSCCode", "orderLineId" ,"orderNumber" , "itemDescription"] } }, "required" : [ "shipmentNumber","shipmentId","shipmentRouteId","shipmentDestination","shipmentSource","shipmentArrivalDate", "totalPackageQuantity"] } - shipmenttrackerV1: | { "$schema": "http://json-schema.org/draft-04/schema#", "id": "http://api.covisint.com/schema/shipmenttracker", "type": "object", "description": "Schema representing a shipmenttracker.", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "shipmentNumber" :{ "type":"string", "description":"Shipment Number." }, "shipmentId" :{ "type":"string", "description":"ShipmentId." }, "shipmentRouteId" :{ "type":"string", "description":"Shipment route Id." }, "shipmentDestination" :{ "type":"string", "description":"Shipment destination." }, "shipmentSource" :{ "type":"string", "description":"Shipment source." }, "shipmentDeviceId" :{ "type":"string", "description":"DeviceId of the shipment." }, "shipmentTrackingStatus" :{ "type":"number", "description":"Shipment tarcking status" }, "shipmentHealthStatus" :{ "type":"number", "description":"Shipment health status." }, "shipmentArrivalDate" :{ "type":"object", "description":"The estimated shipment arrival date." }, "totalPackageQuantity" :{ "type":"integer", "description":"Total package quantity." }, "shipmentContainers" : { "type":"object", "description":" Shipment container attched to the shipmentTracker", "properties":{ "containerId":{ "type":"string", "description":"Container ID of the shipment container" }, "parentContainerId":{ "type":"string", "description":"Parent Container ID " }, "packageLevel":{ "type":"string", "description":"package level of the container" }, "packageType":{ "type":"string", "description":"PackageType of the shipment container" }, "packagedQuantity":{ "type":"integer", "description":"PackagedQuantity of the shipment container" }, "SSSCCode":{ "type":"string", "description":"SSSCCode of the shipment container" }, "orderLineId":{ "type":"integer", "description":"Order Line Id of the shipment container" }, "orderNumber":{ "type":"integer", "description":"Order Number of the shipment container" }, "itemDescription":{ "type":"string", "description":"Item Description of the shipment container" }, "containerDeviceId":{ "type":"string", "description":"Container Device Id of the shipment container" } }, "required": ["containerId", "packageType", "parentContainerId", "packageLevel" , "packagedQuantity" ,"SSSCCode", "orderLineId" ,"orderNumber" , "itemDescription"] } }, "required" : [ "shipmentNumber","shipmentId","shipmentRouteId","shipmentDestination","shipmentSource","shipmentArrivalDate", "totalPackageQuantity"] } traits: - secured: displayName: secured - unsecured: displayName: unsecured - getResponse: displayName: getResponse - getSearchResponse: displayName: getSearchResponse - postResponse: displayName: postResponse - deleteResponse: displayName: deleteResponse - putResponse: displayName: putResponse - putResponseV2: displayName: putResponseV2 - putCreateResponse: displayName: putCreateResponse - taskResponse: displayName: taskResponse - pagableRequest: displayName: pagableRequest - taggable: displayName: taggable - sortable: displayName: sortable - searchable: displayName: searchable /shipmenttrackers: description: "Collection endpoint for shipmenttracker. [Since:1.0]" get: description: "Search shipmenttracker in the realm based on the specified query parameters.[Flow-name:shipmenttracker-search]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.v1+json queryParameters: id: description: Retrieve shipmenttrackers with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve shipmenttrackers with the specified creation instant. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentRouteId: description: Retrieve shipmenttrackers with the specified routeId . Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentNumber: description: Retrieve shipmenttrackers with the specified shipment number . Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentHealthStatus: description: Retrieve shipmenttrackers with the specified shipment health status . Multiple parameters are allowed and the search results will be a union. type: number required: false repeat: false shipmentTrackingStatus: description: Retrieve shipmenttrackers with the specified shipment status (0,1,2) [0 is DRAFT ,1 is STARTED,2 is COMPLETED] Multiple parameters are allowed and the search results will be a union. type: number required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: 50 sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation", +shipmentHealthStatus, "-shipmentHealthStatus", +shipmentTrackingStatus, "-shipmentTrackingStatus"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). responses: "200": description: All shipmenttrackers that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentTracking.v1+json: schema: shipmenttrackers "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [pagableRequest, sortable] post: description: "Create a new shipmenttracker .[Flow-name:create-shipmenttracker]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.v1+json Content-Type: description: The content media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.shipmentTracking.v1+json: schema: shipmenttrackerV1 responses: "201": description: shipmenttracker successfully created. body: application/vnd.com.covisint.platform.shipmentTracking.v1+json: schema: shipmenttracker "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /{trackerId}: description: Endpoint for an individual shipmenttracker. uriParameters: trackerId: description: Unique id of a shipmenttracker. type: string required: false repeat: false get: description: "Get shipmenttracker by ID.[Flow-name:shipmenttracker-getById]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.v1+json queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: 50 sortBy: description: Sort the results based on some criteria. type: string required: false repeat: false example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). responses: "200": description: Successfully retrieved shipmenttracker with given ID. body: application/vnd.com.covisint.platform.shipmentTracking.v1+json: schema: shipmenttracker "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [pagableRequest, sortable] /health: get: description: "Updates shipment tracker health. [Flow-name:update-shipment-health][Since:1.0]." responses: "200": description: Retrieved shipmenttracker with updated health. body: application/vnd.com.covisint.platform.shipmentTracking.health.v1+json: schema: shipmenthealth "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /devices/{deviceId}: uriParameters: deviceId: description: deviceId of the shipment. type: string required: false repeat: false put: description: "Updates shipment tracker device. [Flow-name:update-shipment-device][Since:1.0]." responses: "200": description: Successfully updated the requested shipment device. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: "deletes shipment tracker device. [Flow-name:delete-shipment-device][Since:1.0]." responses: "200": description: Successfully deleteed the requested shipment device. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /containers/{containerId}/devices/{deviceId}: uriParameters: deviceId: description: deviceId of the shipment. type: string required: false repeat: false containerId: description: containerId of the shipment. type: string required: false repeat: false put: description: "Updates shipment container device. [Flow-name:update-shipment-container-device][Since:1.0]." responses: "200": description: Successfully updated the requested container device. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: "deletes shipment container device. [Flow-name:delete-shipment-container-device][Since:1.0]." responses: "200": description: Successfully deleteed the requested container device. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /routes/{routeId}: uriParameters: routeId: description: routeId of the shipment. type: string required: false repeat: false put: description: "Updates shipment tracker route. [Flow-name:update-shipment-route][Since:1.0]." responses: "200": description: Successfully updated the requested shipment route. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /status/{trackingStatus}: uriParameters: trackingStatus: description: "trackingStatus of the shipment.[example:0,1,2]" type: integer required: false repeat: false put: description: "Updates shipment tracker status. [Flow-name:update-shipmenttracker-status][Since:1.0]." responses: "200": description: Successfully updated the requested shipment status. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /devices: get: description: "search shipment route in the IOT platform.[Since:1.0].[Flow-name:shipmenttracker-search-devices]" headers: Accept: description: The media type for v1 shipmnet device searching. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve devices with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve devices with the specified creation instant. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false name: description: Retrieve devices with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false description: description: Retrieve devices with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false active: description: Retrieve devices with the specified active state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false tag: description: Retrieve devices with the specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: 50 sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation", "+name", "-name"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). responses: "200": description: All devices that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentTracking.v1+json: schema: shipmentRoutes "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [searchable, pagableRequest, sortable, getSearchResponse, secured] /routes: get: description: "search shipment route in the IOT platform.[Since:1.0].[Flow-name:shipmenttracker-search-route]" headers: Accept: description: The media type for v1 shipmnet route searching. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve shipment routes with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve shipment routes with the specified creation instant. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false name: description: Retrieve shipment routes with the specified name. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false description: description: Retrieve shipment routes with the specified description. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false active: description: Retrieve shipment routes with the specified active state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false tag: description: Retrieve shipment routes with the specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: 1 pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: 50 sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation", "+name", "-name"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). responses: "200": description: All shipment routes that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoutes "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [searchable, pagableRequest, sortable, getSearchResponse, secured] /{routeId}: uriParameters: routeId: description: routeId of the shipment. type: string required: false repeat: false get: description: "retrieves shipment tracker route. [Flow-name:get-shipmentroute-byId][Since:1.0]." responses: "200": description: Successfully updated the requested shipment route. body: application/vnd.com.covisint.platform.shipmentTracking.v1+json: schema: shipmentRoute "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /devices/synchronize: get: description: "fetch all te device attached to shipment with the updated attribute values. [Since:1.0].[Flow-name:shipmenttracker-device-sync]" headers: Accept: description: The media type for v1 to get shipment device attributes updated values. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.sync.device.v1+json queryParameters: id: description: Retrieve shipmenttrackers with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve shipmenttrackers with the specified creation instant. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentRouteId: description: Retrieve shipmenttrackers with the specified routeId . Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentNumber: description: Retrieve shipmenttrackers with the specified shipment number . Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentHealthStatus: description: Retrieve shipmenttrackers with the specified shipment health status . Multiple parameters are allowed and the search results will be a union. type: number required: false repeat: false shipmentAudit.shipmentTrackingState: description: Retrieve shipmenttrackers with the specified shipment status (0,1,2) [0 is DRAFT ,1 is STARTED,2 is COMPLETED] Multiple parameters are allowed and the search results will be a union. type: number required: false repeat: false shipmentDevice.shipmentId: description: Retrieve shipmenttrackers with the with device attached with the given shipmentIdd . Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false shipmentDevice.containerId: description: Retrieve shipmenttrackers with the with device attached with the given containerId . Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation", +shipmentHealthStatus, "-shipmentHealthStatus", +shipmentAudit.shipmentTrackingState, "-shipmentAudit.shipmentTrackingState"] responses: "200": description: All shipment devices with the latest updated attribute values that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentTracking.sync.device.v1+json: schema: deviceSyncs "400": description: | There was a problem with the client's request. Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /deviceconfigs: get: description: "fetch all te deviceconfiguration with updated attribute values. [Since:1.0].[Flow-name:get-shipmenttracker-attrib-config]" headers: Accept: description: The media type for v1 to get device configuration with updated values. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json queryParameters: id: description: Retrieve deviceconfiguration with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve deviceconfiguration with the specified creation instant. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false attributeId: description: Retrieve deviceconfiguration with the specified attribute Id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false deviceId: description: Retrieve deviceconfiguration with the specified device Id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false responses: "200": description: All configurations that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json: schema: attributeConfiguration "400": description: | There was a problem with the client's request. Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema post: description: "create attribute configuration. [Since:1.0].[Flow-name:create-shipmenttracker-attrib-config]" headers: Accept: description: The media type for atribute configuration. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json Content-Type: description: The media type for atribute configuration. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json responses: "201": description: Successfully created attribute configuration. body: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json: schema: attributeConfiguration "400": description: | There was a problem with the client's request. Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /{attribConfigId}: description: Endpoint for an individual attribute configuration. uriParameters: attribConfigId: description: Unique id of a attribute configuration. type: string required: false repeat: false get: description: "get attribute configuration by ID .[Flow-name:attrib-config-getbyID][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json responses: "200": description: attribute configuration with given ID successfully retrieved. body: application/vnd.com.covisint.platform.deviceViolation.v1+json: schema: deviceViolation "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema put: description: "update attribute configuration. [Since:1.0].[Flow-name:update-shipmenttracker-attrib-config]" headers: Accept: description: The media type for v1 to get device configuration with updated values. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json Content-Type: description: The media type for v1 to get device configuration with updated values. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json responses: "200": description: Attribute configuration updated successfully. body: application/vnd.com.covisint.platform.shipmentTracking.attrib.config.v1+json: schema: attributeConfiguration "400": description: | There was a problem with the client's request. Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema delete: description: "deletes attribute configuration. [Flow-name:delete-shipmenttracker-attrib-config][Since:1.0]." responses: "204": description: Successfully deleted the requested attribute configuration. "400": description: | There was a problem with the request. ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema /deviceviolations: post: description: "Create a new device violaton .[Flow-name:create-device-violation][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.deviceViolation.v1+json Content-Type: description: The content media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.deviceViolation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.deviceViolation.v1+json: schema: deviceViolation responses: "201": description: deviceViolation successfully created. body: application/vnd.com.covisint.platform.deviceViolation.v1+json: schema: deviceViolation "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] get: description: "search device violatons .[Flow-name:search-device-violation][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.deviceViolation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve deviceviolations with the specified id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false creation: description: Retrieve deviceviolations with the specified creation instant. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false violatedDeviceId: description: Retrieve deviceviolations with the specified violatedDeviceId. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false violatedDeviceState: description: Retrieve deviceviolations with the specified violatedDeviceState. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false violatedAttributeName: description: Retrieve deviceviolations with the specified violatedAttributeName. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false responses: "201": description: deviceViolations successfully retrieved. body: application/vnd.com.covisint.platform.deviceViolation.v1+json: schema: deviceViolations "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /{violationId}: description: Endpoint for an individual device violation. uriParameters: violationId: description: Unique id of a device violation. type: string required: false repeat: false get: description: "get device violatons by ID .[Flow-name:get-deviceViolation-by-ID][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.deviceViolation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "201": description: deviceViolations with given ID successfully retrieved. body: application/vnd.com.covisint.platform.deviceViolation.v1+json: schema: deviceViolation "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was an error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:data:illegal - The following properties contained illegal values: Origin location : {originLocationId} does not exist, Destination location : {destinationLocationId} does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /shipments: get: description: "get all shipments .[Flow-name:get-all-shipments][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentConnector.shipments.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Retrieved all shipments(response collection may be empty). body: application/vnd.com.covisint.platform.shipmentConnector.shipments.v1+json: schema: shipmentConnectorResponse "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, secured] /{shipmentId}: description: Endpoint for fetching shipment by Id. uriParameters: shipmentId: description: Unique id of a shipment. type: string required: false repeat: false get: description: "get Shipment details by Id .[Flow-name:get-shipment-details-by-Id][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentConnector.shipments.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Retrieved shipment for given shipmentId (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentConnector.shipments.v1+json: schema: shipmentConnectorResponse "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, secured] /containers: description: Endpoint for an individual fetching container details by shipment id. get: description: "get container details by shipment id .[Flow-name:get-container-details-by-shipmentId][Since:1.0]." headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentConnector.containers.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: Retrieved all containers for the given shipmentId (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentConnector.containers.v1+json: schema: shipmentConnectorResponse "400": description: | There was a problem with the client's request. ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: An unhandled server-side error occurred. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, secured]