#%RAML 0.8 title: Shipment Route API baseUri: "https://api.us1.covisint.com/shipmentroute/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" ] } ] } - locations: | { "id": "http://api.covisint.com/schema/locations", "$schema": "http://json-schema.org/draft-04/schema", "description": "Collection of locations.", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/location#" } } - location: | { "id": "http://api.covisint.com/schema/location", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Schema representing a location.", "type": "object", "extends": { "$ref":"http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The location name (internationalized).", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/internationalString#" } }, "description": { "description": "The location description (internationalized).", "type": "array", "items": { "$ref": "http://api.covisint.com/schema/internationalString#" } }, "active": { "type":"boolean", "description":"The state of the location. By default a location is always active.", "default" : true }, "tags": { "description" : "The list of tags associated with location.", "type": "array", "items": { "$ref" : "http://api.covisint.com/schema/tags#" }, "readOnly" : true }, "buildingName": { "type":"string", "description":"Building name of the location" }, "addressLine1": { "type":"string", "description":"Address line 1" }, "addressLine2": { "type":"string", "description":"Address line 2" }, "city": { "type":"string", "description":"Location's city" }, "state": { "type":"string", "description":"Location's state" }, "postalCode": { "type":"string", "description":"Postal code of the location" }, "country": { "type":"string", "description":"Location's country" }, "formattedAddress": { "type":"string", "description":"Complete address of the location as returned by Google" }, "latitude": { "type":"number", "description":"Latitude of the location as returned by Google" }, "longitude": { "type":"number", "description":"Longitude of the location as returned by Google" }, "contact": { "description" : "The location's contact entity", "type": "array", "items": { "$ref" : "http://api.covisint.com/schema/location.contact#" } } }, "required": ["name","postalCode","country"] } - location.contact: | { "id" : "http://api.covisint.com/schema/location.contact", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The location's contact entity. Name and at least one of the other remaining fields is required.", "type" : "object", "properties" : { "name" : { "description" : "Name of the contact entity", "type" : "string", "minLength" : 1, "maxLength" : 100 }, "anyOf" : [ { "phone" : { "description" : "Phone number of the contact", "type" : "string", "minLength" : 1, "maxLength" : 100 } }, { "email" : { "description" : "Email of the contact", "type" : "string", "minLength" : 1, "maxLength" : 100 } }, { "fax" : { "description" : "Fax of the contact", "type" : "string", "minLength" : 1, "maxLength" : 25 } } ] } } - 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#" } } - 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"] } 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 /locations: description: "Collection endpoint for locations. [Since:1.0]" get: description: "Search locations in the realm based on the specified query parameters.[Flow-name:shipment-route-search-locations]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.location.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 locations 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 locations 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 locations 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 locations 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 locations with the specified active state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false city: description: Retrieve locations with the specified city. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false postalCode: description: Retrieve locations with the specified postal code. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false country: description: Retrieve locations with the specified country. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false address: description: Retrieve locations which contain the specified query value as part of its formatted address field. Supports FUZZY search. Wildcards not supported. Partial word matches not supported. type: string required: false repeat: false latitude: description: Retrieve locations with the specified latitude. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false longitude: description: Retrieve locations with the specified longitude. 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). tag: description: Retrieve locations with the specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false responses: "200": description: All locations that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.shipmentRoute.location.v1+json: schema: locations "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: [pagableRequest, sortable, taggable, getSearchResponse, secured] post: description: "Create a new location.[Flow-name:shipment-route-create-location]" headers: Accept: description: The accept media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.location.v1+json Content-Type: description: The content media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.location.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.shipmentRoute.location.v1+json: schema: location responses: "201": description: Location successfully created. body: application/vnd.com.covisint.platform.shipmentRoute.location.v1+json: schema: location "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] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Latitude/longitude values could not be found for the given address. Status code: + framework:resource:location:not:found - Could not find the latitude/longitude value for the location : {address} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | Duplicate name or duplicate lat/long value of the address. ___ Substatus codes and error messages are mentioned below: + framework:resource:conflict:exists - Location with the same name already exists with id : {existingId} + framework:resource:conflict:exists - Location with the same latitude/longitude already exists with id : {existingId} 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] /count: description: "Endpoint to return the count of locations that match the given query criteria. [Since:1.0]" get: description: "Count number of locations in the realm based on the specified query parameters.[Flow-name:shipment-route-count-locations]" headers: Accept: description: The accept media type type: string required: true repeat: false example: text/plain 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 location count 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 location count 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 location count 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 location count 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 location count with the specified active state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false city: description: Retrieve location count with the specified city. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false postalCode: description: Retrieve location count with the specified postal code. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false country: description: Retrieve location count with the specified country. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false address: description: Retrieve location count which contain the specified query value as part of its formatted address field. Supports FUZZY search. Wildcards not supported. Partial word matches not supported. type: string required: false repeat: false latitude: description: Retrieve location count with the specified latitude. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false longitude: description: Retrieve location count with the specified longitude. 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 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). tag: description: Retrieve location count with the specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false responses: "200": description: Count of all locations that satisfy the query parameters was successfully retrieved (response collection may be empty). body: plain/text: "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: [pagableRequest, sortable, taggable, getSearchResponse, secured] /{locationId}: description: "Endpoint for an individual location. [Since:1.0]" uriParameters: locationId: description: The unique location id. type: string required: false repeat: false minLength: 1 get: description: "Retrieve the requested location.[Flow-name:shipment-route-get-location]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.location.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: Location retrieved successfully. body: application/vnd.com.covisint.platform.shipmentRoute.location.v1+json: schema: location "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: | Location with the given id was not found. Status code: + framework:resource:missing - A resource with the following ID was not found: {locationId} 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] put: description: "Updates an existing location.[Flow-name:shipment-route-update-location]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.location.v1+json Content-Type: description: The content media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.location.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.shipmentRoute.location.v1+json: schema: location responses: "200": description: Location was successfully updated. body: application/vnd.com.covisint.platform.shipmentRoute.location.v1+json: schema: location "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] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Location with the given id was not found. Status code: + framework:resource:location:not:found - A resource with the following ID was not found: {locationId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | Duplicate name or duplicate lat/long value of the address. ___ Substatus codes and error messages are mentioned below: + framework:resource:conflict:exists - Location with the same name already exists with id : {existingId} + framework:resource:conflict:exists - Location with the same latitude/longitude already exists with id : {existingId} + framework:resource:conflict:id - The ID of the resource in the request, {requestUrlId}, does not match the ID of the given resource, {requestBodyId} 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] delete: description: "Deletes a location if it is not attached to any shipment route. [Since:1.0] [Flow-name:shipment-route-delete-location]" responses: "204": description: The location was successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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] /tags/{tag}: description: "Tag endpoint for location. [Since:1.0]" uriParameters: tag: description: The tag value. type: string required: true repeat: false minLength: 1 maxLength: 2000 is: [secured] put: description: "Tags the specified location.[Flow-name:shipment-route-tag-location]" 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 added. "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] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: The location 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 "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 delete: description: "Removes a tag from the location.[Flow-name:shipment-route-untag-location]" 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. "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 location 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 "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] /shipmentRoutes: description: "Collection endpoint for shipment routes. [Since:1.0]" get: description: "Search shipment routes in the realm based on the specified query parameters.[Flow-name:shipment-route-search-routes]" headers: Accept: description: The accept media type 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 originLocation.id: description: Retrieve shipment routes with the specified origin location id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false destinationLocation.id: description: Retrieve shipment routes with the specified destination location id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false location.id: description: Retrieve shipment routes associated with the specified location id. Search includes origin, destination and all intermediate locations. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false createGeofence: description: To create a geofence around the route, at the time of route creation. Default is true. type: boolean required: false repeat: false encrichRoute: description: To incerease the number of coordinates in the route, before creating the geofence. Default is false. type: boolean required: false repeat: false geofenceRadius: description: Radius in meter of the geofence around the route. Default set to 200 meters. 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", "+name", "-name"] example: +creation, -name (These will sort by creation ascending, name descending. If "+/-" prefix is omitted, then an ascending sort is assumed). 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 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: [pagableRequest, sortable, taggable, getSearchResponse, secured] post: description: "Create a new shipment route.[Flow-name:shipment-route-create-route]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.v1+json Content-Type: description: The content media type 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 body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoute responses: "201": description: Shipment route successfully created. body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoute "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 "409": description: | Duplicate name or location sequence of the route. ___ Substatus codes and error messages are mentioned below: + framework:resource:conflict:exists - Shipment route with the same name already exists with id : {existingId} + framework:resource:conflict:exists - Shipment route : {existingId} already exists with the same sequence of locations 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] /count: description: "Endpoint to return the count of shipment routes that match the given query criteria. [Since:1.0]" get: description: "Count number of shipment routes in the realm based on the specified query parameters.[Flow-name:shipment-route-count-routes]" headers: Accept: description: The accept media type type: string required: true repeat: false example: text/plain 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 count 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 count 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 count 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 count 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 count with the specified active state. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false originLocation.id: description: Retrieve shipment routes count with the specified origin location id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false destinationLocation.id: description: Retrieve shipment routes count with the specified destination location id. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false location.id: description: Retrieve shipment routes count associated with the specified location id. Search includes origin, destination and all intermediate locations. 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 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). tag: description: Retrieve shipment routes count with the specified tag. Multiple parameters are allowed and the search results will be a union. type: string required: false repeat: false responses: "200": description: Count of all shipment routes that satisfy the query parameters was successfully retrieved (response collection may be empty). body: plain/text: "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: [pagableRequest, sortable, taggable, getSearchResponse, secured] /{shipmentRouteId}: description: "Endpoint for an individual route. [Since:1.0]" uriParameters: # locationId: # description: The unique shipment route id. # type: string # required: false # repeat: false # minLength: 1 shipmentRouteId: displayName: shipmentRouteId type: string required: true repeat: false get: description: "Retrieve the requested shipment route.[Flow-name:shipment-route-get-route]" headers: Accept: description: The accept media type 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 responses: "200": description: Shipment route retrieved successfully. body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoute "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: | Shipment route with the given id was not found. Status code: + framework:resource:missing - A resource with the following ID was not found: {shipmentRouteId} 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] put: description: "Updates an existing route. [Flow-name:shipment-route-update-route]" headers: Accept: description: The accept media type type: string required: true repeat: false example: application/vnd.com.covisint.platform.shipmentRoute.v1+json Content-Type: description: The content media type 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 body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoute responses: "200": description: Shipment route was successfully updated. body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoute "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] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Route with the given id was not found. Status code: + framework:resource:missing - A resource with the following ID was not found: {shipmentRouteId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | Duplicate name or duplicate location sequence value of the location. ___ Substatus codes and error messages are mentioned below: + framework:resource:conflict:exists - Shipment route with the same name already exists with id : {existingId} + framework:resource:conflict:exists - Shipment route : {existingId} already exists with the same sequence of locations + framework:resource:conflict:id - The ID of the resource in the request, {requestUrlId}, does not match the ID of the given resource, {requestBodyId} 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] delete: description: "Deletes a shipment route if it is not attached to any shipment route. [Since:1.0] [Flow-name:shipment-route-delete-route]" responses: "204": description: The shipment route was successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + 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: {shipmentRouteId} 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] /createGeofence: description: "Endpoint to create a geofence for a route.[Since:1.0]" uriParameters: # geofenceRadius: # description: Radius of the geofence. Default is 200meters # type: number # required: false # repeat: false # enrichRoute: # description: Enrich route for the geofence creation. Default is false. # type: boolean # required: false # repeat: false is: [secured] post: description: "To create a geofence around the route.[Flow-name:shipment-route-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: Route geofence created successfully. body: application/vnd.com.covisint.platform.shipmentRoute.v1+json: schema: shipmentRoute "404": description: The shipment route 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 "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 /deleteGeofence: description: "Endpoint to create a geofence for a route.[Since:1.0]" is: [secured] delete: description: "To delete a route geofence.[Flow-name:shipment-delete-route-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: Route geofence deleted successfully. "404": description: The shipment route 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 "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 /tags/{tag}: description: "Tag endpoint for shipment route. [Since:1.0]" uriParameters: tag: description: The tag value. type: string required: true repeat: false minLength: 1 maxLength: 2000 is: [secured] put: description: "Tags the specified shipment route.[Flow-name:shipment-route-tag-route]" 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 added. "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 shipment route 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 "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 delete: description: "Removes a tag from the shipment route.[Flow-name:shipment-route-untag-route]" 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. "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 shipment route 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 "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] /tasks/activate: description: "Endpoint to activate a shipment route. [Since:1.0]" post: description: "Activates the shipment route. Invoking this on an active shipment route has no effect.[Flow-name:shipment-route-activate-route]" 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: Shipment route successfully activated. "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 "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] /tasks/deactivate: description: "Endpoint to deactivate a shipment route. [Since:1.0]" post: description: "Deactivates the shipment route. Invoking this on an inactive shipment route has no effect.[Flow-name:shipment-route-deactivate-route]" 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: Shipment route successfully deactivated. "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 "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]