--- title: "Vehicle's stolen state." method: GET path: "/fleets/{fid}/vehicles/{vid}/stolen/{sid}" tags: ["Vehicles"] --- # Vehicle's stolen state. `GET /fleets/{fid}/vehicles/{vid}/stolen/{sid}` ## Request - Base URL: `https://api-cert.groupe-psa.com/connectedcar/v3` - URL: `https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/vehicles/{vid}/stolen/{sid}` - Auth: HTTP basic and API key in query parameter `client_id` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns information about a specific stolen context for a vehicle. ## Path parameters - `fid` string, required - `vid` string, required - `sid` string, required ## Response `200` Stolen response - Stolen - `createdAt` string, date-time, required: Date when the resource has been created. - `updatedAt` string, date-time: Date when the resource has been updated. - `_links` object, required - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `vehicle` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `id` string, required - `state` boolean, required: Stolen state of the vehicle (True means the vhicle is reported stolen). - `startedAt` string, date-time, required: Stolen vehicle start time. - `endAt` string, date-time: Stolen vehicle stop time. - `startPosition` object: The position (last vehicle known one) where the vehicle is reported stolen. - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects. - `type` 'Point', required - `properties` object, required - `createdAt` string, date-time, required: Date when the resource has been created. - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `heading` integer: Course angle expressed in degree. - `signalQuality` integer - `type` 'Estimated' | 'Acquire' - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode. - `endPosition` object: The position (last vehicle known one) where the stolen state is not active anymore. - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects. - `type` 'Point', required - `properties` object, required - `createdAt` string, date-time, required: Date when the resource has been created. - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `heading` integer: Course angle expressed in degree. - `signalQuality` integer - `type` 'Estimated' | 'Acquire' - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode. ## Other responses - `default` (unresolved $ref) --- [API](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api.md) - [All operations](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/llms.txt) - [OpenAPI document](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/revisions/023ff3e3fe51?raw)