#%RAML 0.8 title: Geofence API baseUri: "https://api.us1.covisint.com/geofence/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" ] } ] } - geofences: | { "id": "http://api.covisint.com/schema/geofence", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of geofence definitions.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/geofence#" } } - geofenceProximityResponses: | { "id": "http://api.covisint.com/schema/geofenceProximityResponse", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of geofence proximity response.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/geofenceProximityResponse#" } } - geofenceDwellTime: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Geofence dwell time schema", "properties": { "amount":{"type":"number","description":"dwell time amount."}, "timeUnit":{"type":"string","description":"dwell time unit. Valid time units are [millisecond, second, minute, hour, day]. It is a non mandatory parameter, by default time unit is millisecond."} }, "required" : [ "amount"] } - geofenceAssociation: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Geofence Association schema", "extends": { "$ref": "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "geofenceId":{"type":"string","description":"Geofence Id"}, "resourceId":{"type":"string","description":"Resource Id"}, "resourceType":{"description":"Type of the resource, Valid type are[ DEVICE, DEVICETEMPLATE, SHIPMENTROUTE ]","enum":["DEVICE","DEVICETEMPLATE","SHIPMENTROUTE"]}, "isActive":{"type":"boolean","description":"Set to activate or deactivate"}, "state":{"type":"string","description":"tells if the association is inside or outside a geofence, read-only property.","readOnly": true}, "datetimereceived":{"type":"number","description":"tell when was the last time state of the association changed, read-only property","readOnly": true}, "latitude":{"type":"string","description":"latitude of the association, when the last time state changed, read-only property","readOnly":true}, "longitude":{"type":"string","description":"longitude of the association, when the last time state changed, read-only property","readOnly":true} }, "required" : [ "geofenceId","resourceId","resourceType"] } - geofenceResourceStateHistory: | { "$schema": "http://json-schema.org/draft-04/schema", "description": "Geofence Resource State history.", "extends": { "$ref": "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "geofenceId":{"type":"string","description":"Geofence Id"}, "resourceId":{"type":"string","description":"Resource Id"}, "resourceType":{"description":"Type of the resource, Valid type are[ DEVICE, DEVICETEMPLATE, SHIPMENTROUTE ]","enum":["DEVICE","DEVICETEMPLATE","SHIPMENTROUTE"]}, "isActive":{"type":"boolean","description":"Set to activate or deactivate"}, "resourceStateHistory": { "type": "array", "description": "Contains array of all the states of the geofence association", "items": { "type": "object", "properties": { "datetimereceived": { "type": "string", "description": "TimeStamp of the state change." }, "state": { "type": "string", "description": "State of the geofenceAssociation, it can be inside or outside." }, "latitude": { "type": "string", "description": "The latitude in decimal format." }, "longitude": { "type": "string", "description": "The longitude in decimal format." }, "messageId": { "type": "string", "description": "MessageId which has cased the state change" } } } } } } - geofence: | { "id": "http://api.covisint.com/schema/geofence", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "description": "Schema representing a geofence.", "extends": { "$ref": "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "active" :{ "type":"boolean", "description":"to activate or deactive a geofence, by default a geofence is deactive " }, "maxSearchRadius":{ "type":"string", "description":"maximum search radius in decimal value. Example 3000 or 300.2, all values will be considered to be in meters." }, "name": { "description": "The geofence name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The geofence description (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "dwellTime":{ "description": "Dwell time of the geofence.", "type":"object", "$ref": "http://api.covisint.com/schema/geofenceDwellTime#" }, "polygon": { "type": "array", "description": "Polygon of the geofence", "items": { "type": "object", "properties": { "latitude": { "type": "string", "description": "The latitude in decimal format." }, "longitude": { "type": "string", "description": "The longitude in decimal format." } }, "required" : [ "latitude", "longitude" ] } }, "tags": { "description": "The tags associated with this document.", "$ref": "http://api.covisint.com/idm/schema/tags#", "readOnly": true } }, "required" : [ "name", "polygon","maxSearchRadius"] } - geofenceProximityResponse: | { "id": "http://api.covisint.com/schema/geofenceProximityResponse", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of geofence definitions.", "properties" :{ "GeoLocation" :{ "description" : "Input latitude and longitude.", "type" : "object", "properties" :{ "latitude": { "type": "string", "description": "The latitude in decimal format." }, "longitude": { "type": "string", "description": "The longitude in decimal format." } } }, "isInsideGeofence" : { "type": "boolean", "description": "Tells if a input latitude, longitude is inside a geofence." }, "Found within the search range" : { "type": "boolean", "description": "Tells if a input latitude, longitude is inside the search range of the geofence." }, "Nearest Coordinate found is" : { "description" : "Nearest coordinate to the input latitude and longitude", "type" : "object", "properties" : { "Nearest coordinate" :{ "description" : "Vertex of geofence which is nearest to the input latitude, longitude" }, "Distance from nearest coordinate" : { "type": "string", "description": "Distance in kilometers from the nearest vertex of the geofence ." } } }, "Configured Geofence" :{ "description" : "Geofence which is used to check proximity.", "type" : "object", "$ref": "http://api.covisint.com/schema/geofence#" } } } 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 /geofence: description: "Collection endpoint for geofence resources.[Since:1.0]" get: description: "Search geofence in the realm based on the specified query parameters.[Flow-name:geofence-search-geofence]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.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: Filter geofence by their unique id. Case-insensitive, wild card and fuzzy search is supported. Multiple parameter values can be provided, in which case any matching geofence will be returned. type: string required: false repeat: false name: description: Filter geofence by the name. Case-insensitive, wild card and fuzzy search is supported. Multiple parameter values can be provided, in which case any matching geofence will be returned. type: string required: false repeat: false description: description: Filter geofence by the description. Case-insensitive, wild card and fuzzy search is supported. Multiple parameter values can be provided, in which case any matching geofence will be returned. type: string required: false repeat: false creation: description: Retrieve geofence with the specified creation. Range search is supported. Multiple parameters are allowed and the search results will be a union. the pattern would be creation=>value1&creation=value1&creation=1466612312576&creation=<1466612312579 will provide geofence association >= 1466612312576 and <=1466612312579. type: string required: false repeat: false geofenceId: description: Retrieve geofence associations for the given geofence id. type: string required: false repeat: false resourceId: description: Retrieve geofence associations for the given resource id. type: string required: false repeat: false resourceType: description: Retrieve geofence associations for the given resource type. Valid Resource types are DEVICE, DEVICETEMPLATE, SHIPMENTROUTE type: string required: false repeat: false isActive: description: Retrieve geofence association which are active or deactive based on isActive parameter. type: boolean required: false repeat: false geofenceResourceState.state: description: Retrieve geofence association for the given state, inside or outside. type: string required: false repeat: false geofence.name: description: Retrieve geofence association attached to the geofence name type: string required: false repeat: false geofence.description: description: Retrieve geofence association attached to the geofence description type: string required: false repeat: false geofence.tag: description: Retrieve geofence association attached to the geofence tag type: string required: false repeat: false geofence.id: description: Retrieve geofence association attached to the geofence id 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"] 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 geofence association that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.geofence.association.v1+json: schema: geofenceAssociation "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 a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing query parameters: {paramName} + 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 "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] post: description: "post end to create a new geofence association [Since:1.0][Flow-name:geofence-create-geofence-association]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.geofence.association.v1+json Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.geofence.association.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.geofence.association.v1+json: schema: geofenceAssociation responses: "201": description: A new geofence association was created and returned in the body. body: application/vnd.com.covisint.platform.geofence.association.v1+json: schema: geofenceAssociation "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:illegal - The following properties contained illegal values: {fieldName(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 "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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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] /association/{associationId}: description: Endpoint to delete geofence association uriParameters: associationId: displayName: associationId type: string required: true repeat: false delete: description: "Removes a tag from the geofence association. [Since:1.0][Flow-name:geofence-delete-geofence-association]" responses: "204": description: Successfully removed from the geofence association. "400": description: | There was a problem with the client's 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse] /association/{associationId}/activate: description: Endpoint to activate geofence association uriParameters: associationId: displayName: associationId type: string required: true repeat: false put: description: "Activate geofence association. [Since:1.0][Flow-name:geofence-activate-geofence-association]" headers: 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: Successfully activated geofence association. "400": description: | There was a problem with the client's 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} 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: [secured] /association/{associationId}/deactivate: description: Endpoint to activate geofence association uriParameters: associationId: displayName: associationId type: string required: true repeat: false put: description: "Deactivate geofence association. [Since:1.0][Flow-name:geofence-deactivate-geofence-association]" headers: 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: Successfully deactivated geofence association. "400": description: | There was a problem with the client's 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} 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: [secured] /association/{associationId}/resourceStateHistory: description: Endpoint to fetch geofecnce resource state change history. uriParameters: associationId: description: unique id of the geofence association. type: string required: false repeat: false get: description: "Endpoint to fetch geofecnce resource state change history. [Since:1.0][Flow-name:geofence-get-geofence-resource-state-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.geofence.resource.state.history.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: startDateTime: description: time in epoch from which the records will be fetched. If start time is missing, then it will fetch records from the beging. type: number required: false repeat: false endDateTime: description: time in epoch till which the records will fetched. If end time is missing, then it will fetch records till the current time. type: number required: false repeat: false body: application/vnd.com.covisint.platform.geofence.resource.state.history.v1+json: schema: geofenceResourceStateHistory responses: "201": description: List of all the geofence resource state history. body: application/vnd.com.covisint.platform.geofence.resource.state.history.v1+json: schema: geofenceResourceStateHistory "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:illegal - The following properties contained illegal values: {fieldName(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 "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: [secured] /checkLocation: description: Endpoint to check postion of input latitude, longitude w.r.t all the geofences in a realm. get: description: "Endpoint to check postion of input latitude, longitude w.r.t all the geofences in a realm.[Since:1.0][Flow-name:geofence-get-check-all-geofence-proximity]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.check.proximity.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: latitude: description: input latitude in decimal format. type: string required: true repeat: false longitude: description: input longitude in decimal format. type: string required: true repeat: false responses: "200": description: geofence was successfully retrieved by its id. body: application/vnd.com.covisint.geofence.check.proximity.v1+json: schema: geofenceProximityResponses "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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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] /{geofenceId}/checkLocation: description: Endpoint to check postion of input latitude, longitude w.r.t all the geofences in a realm. uriParameters: geofenceId: description: Unique id of the geofence. type: string required: false repeat: false get: description: "Endpoint to check postion of input latitude, longitude w.r.t all the geofences in a realm.[Since:1.0][Flow-name:geofence-get-check-geofence-proximity]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.check.proximity.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: latitude: description: input latitude in decimal format. type: string required: true repeat: false longitude: description: input longitude in decimal format. type: string required: true repeat: false responses: "200": description: geofence was successfully retrieved by its id. body: application/vnd.com.covisint.geofence.check.proximity.v1+json: schema: geofenceProximityResponse "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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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] /{geofenceId}: description: Endpoint for an individual geofence. uriParameters: geofenceId: description: Unique id of the geofence. type: string required: false repeat: false get: description: "Retrieve the geofence by its unique id.[Flow-name:geofence-get-geofence]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.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: geofence was successfully retrieved by its id. body: application/vnd.com.covisint.geofence.v1+json: schema: geofence "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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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] /{geofenceId}/tasks/activate: description: Activation of geofence. uriParameters: geofenceId: displayName: geofenceId type: string required: true repeat: false is: [secured] post: description: "Activates a geofence. [Since:1.0][Flow-name:geofence-activate-geofence]" headers: 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: geofenceId: description: The id of the geofence to activate. type: string required: true repeat: false responses: "204": description: geofence successfully activated. "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 a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} 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 /{geofenceId}/tasks/deactivate: description: Deactivation of geofence. uriParameters: geofenceId: displayName: geofenceId type: string required: true repeat: false is: [secured] post: description: "Deactivates a geofence. [Since:1.0][Flow-name:geofence-deactivate-geofence]" headers: 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: geofenceId: description: The id of the geofence to deactivate. type: string required: true repeat: false responses: "204": description: geofence successfully deactivated. "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 a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} 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 /{geofenceId}/tags/{tag}: description: Collection endpoint for geofence tags. uriParameters: tag: description: The tag for the geofence. type: string required: true repeat: false geofenceId: displayName: geofenceId type: string required: true repeat: false is: [secured] put: description: "Associates a tag to the geofence. [Since:1.0][Flow-name:geofence-update-tag-geofence]" headers: 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: "204": description: The tag was successfully set to the geofence. "400": description: | There was a problem with the client's 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:invalid:header:value - Invalid x-requestor 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 "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} 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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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: [putResponse] delete: description: "Removes a tag from the geofence. [Since:1.0][Flow-name:geofence-remove-tag-geofence]" headers: 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: "204": description: The tag was successfully removed from the geofence. "400": description: | There was a problem with the client's 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:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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: [deleteResponse] /{geofenceId}/dwellTime/{dwellTime}: description: Collection endpoint for geofence dwell time. uriParameters: # dwellTimeUnit: # description: Geofence dwell time unit. Valid values are millisecond, second, minute, hour, day. It is not mandatory parameter, default is millisecond. # type: string # required: false # repeat: false geofenceId: displayName: geofenceId type: string required: true repeat: false dwellTime: displayName: dwellTime type: string required: true repeat: false is: [secured] put: description: "Geofence dwell time unit. [Since:1.0][Flow-name:geofence-update-geofence-dwelltime]" headers: 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: "204": description: Updated successfully. "400": description: | There was a problem with the client's 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:invalid:header:value - Invalid x-requestor 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 "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} 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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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: [putResponse] /{geofenceId}/dwellTime: description: Collection endpoint to get geofence dwell time. uriParameters: # dwellTimeUnit: # description: Geofence dwell time unit. Valid values are millisecond, second, minute, hour, day. It is not mandatory parameter, default is millisecond. # type: string # required: false # repeat: false geofenceId: displayName: geofenceId type: string required: true repeat: false is: [secured] get: description: "Retrieve the geofence by its unique id.[Flow-name:geofence-get-geofence-dwelltime]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.dwelltime.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: geofence was successfully retrieved by its id. body: application/vnd.com.covisint.geofence.dwelltime.v1+json: schema: geofenceDwellTime "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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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] /tracking/{deviceId}: description: "Collection endpoint for Device geolocation history .[Since:1.0]" uriParameters: deviceId: description: Unique id of the device. type: string required: false repeat: false get: description: "Get device history geolocations.[Flow-name:tracking-get-device-history-geolocation]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.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: startDateTime: description: "Epoch Start Date from which device geolocation will be searched. example:1565270355045" type: string required: true repeat: false endDateTime: description: "Epoch End Date to which device geolocation will be searched. example:1565290355045. If not provided then end time will be current system time." type: string required: false repeat: false group: description: "Used to reduce the results, depending the group value.Enum values accepetd are:[MINUTE, HOUR, DAY, WEEK, MONTH, YEAR]" type: string required: true repeat: false enum: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR] responses: "200": description: Matching geofence were retrieved successfully. body: application/vnd.com.covisint.geofence.v1+json: schema: geofences "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 unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown 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: [getSearchResponse, secured] /tracking/distance: description: "Collection endpoint for Device geolocation history .[Since:1.0]" get: description: "Get device history geolocations.[Flow-name:tracking-get-distance-between-locations]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.geofence.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: lat1: description: first latitude type: string required: true repeat: false lng1: description: first longitude type: string required: false repeat: false lat2: description: second latitude type: string required: true repeat: false lng2: description: second longitude type: string required: false repeat: false responses: "200": description: Distance between the two locations in kilometers. body: text/plain: "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 "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: [secured]