NAV navbar
logo
jsonsse

TME Customer REST API Documentation

version 1.4.0
baseUri https://consumer-api.toyota-europe.com/
protocols HTTPS
mediaType application/json

Overview

This is the endpoint for the TME consumer domain. This will become the canonical source for consumer information throughout the company.

The API and data format is heavily inspired by JSON-API. This gives you a nice ecosystem of tools to consume the data available here. Where possible schemas are available.

The API has 2 resources: source-records and consumers. source-records are records for consumers as they exist in the various source systems, no processing has been done to these. consumers are a view on clusters of source-records. Each cluster is our current best representation of a single person. You can request multiple views of a different consumer: each view merges all the source records in a different way. You cannot update a consumer directly, only source-records.

Changelog

API versionChanges
1.4.0 (current)Primary key of clusters is a UUID (persistent id) instead of hashId
1.3.0
1.2.0Allow PATCHing source-record attributes with null to remove an attribute
1.1.0NMSC statistics counts broken down per source-system
1.0.0Original release

Authentication

The Consumer API only supports OAuth2 for authentication.

Client systems will need to authenticate with OAuth2 and set the JWT token they obtain as a bearer token in the authorization header. Such a token can be obtained by calling the endpoint corresponding to the environment and setting the correct values in the request body:

KeyValue
client_idyour_client_id
client_secretyour_client_secret
scopeapi://your_client_id/.default
grant_typeclient_credentials

The following OAuth2 endpoints are used in the different environments:

EnvironmentAPI URLOAuth2 URL
Developmenthttps://consumer-apid.toyota-europe.comhttps://login.microsoftonline.com/41cb5478-1f8a-4a8e-a2b7-58bbc1198c52/oauth2/v2.0/token
Acceptancehttps://consumer-apia.toyota-europe.comhttps://login.microsoftonline.com/33690b94-3f16-4d1a-9205-84421d2501e4/oauth2/v2.0/token
Productionhttps://consumer-api.toyota-europe.comhttps://login.microsoftonline.com/52b742d1-3dc2-47ac-bf03-609c83d9df9f/oauth2/v2.0/token

Further information on JWT tokens can be found here.

Authenticate with OAuth2 to obtain a token.

curl --location --request POST 'https://login.microsoftonline.com/41cb5478-1f8a-4a8e-a2b7-58bbc1198c52/oauth2/v2.0/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=1722da82-2b9b-483e-a62d-c62f9e48435e' \
--data-urlencode 'client_secret=my-password' \
--data-urlencode 'scope=api://1722da82-2b9b-483e-a62d-c62f9e48435e/.default' \
--data-urlencode 'grant_type=client_credentials'

Response body

{
"token_type": "Bearer",
"expires_in": 3599,
"ext_expires_in": 3599,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"
}

Use the token as a bearer token in the Consumer Domain

curl -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg' -XGET 'https://consumer-apid.toyota-europe.com/nmscCodes/tgb/sourceNames/portal/source-records?version=1.0.0'

Examples

Bulk extraction

Server-sent-events are an extension to the HTTP standard. It effectively keeps the connection open indefinitely, so the server can keep sending new events. When used for bulk extraction we will emit every record as a record event and close the connection once every record has been sent. The client is supposed to keep track of the last event it has seen. Should the connection be lost before all the data was transferred, the client can reopen the connection and resume from the last event it has seen by specifying the last-event-id header.

The server-sent events protocol is text-based and very easy, but clients are available in most languages:

LanguageClient
C#https://github.com/ServiceStack/ServiceStack/wiki/C%23-Server-Events-Client
Gohttps://github.com/r3labs/sse
Javahttps://jersey.java.net/documentation/2.1/sse.html
JavaScripthttps://www.npmjs.com/package/eventsource
Pythonhttps://pypi.python.org/pypi/sseclient/0.0.5

Single source-record payload

What follows is an elaborate example of a source-record payload accepted by our API. It is intended to showcase the different attributes we support and their purpose.

It is likely that you will be unable to populate some of our attributes. Please keep in mind that, aside from source-record ID and type, none of our attributes are mandatory. If no equivalent data field exists on your side, just omit the attribute from the payload entirely.

{
  "data": {
    "id": "ce35c200-7623-11e4-82f8-test",
    "type": "person",
    "attributes": {
      "givenName": "Christopher",
      "middleName": "John",
      "familyName": "Smith",
      "firstInitial": "S",
      "honorificPrefix": "Mr",
      "honorificSuffix": "PhD",
      "gender": "male",
      "birthDate": "1981-12-31",
      "profession": "IT Professional",
      "civilStatus": "single",
      "nationality": ["GB"],
      "createdTimestamp": "2015-09-28T15:45:07.7207642Z",
      "lastUpdatedTimestamp": "2018-09-28T15:45:07.7207642Z",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "GB",
            "idNumber": "34563243AGHFD"
          }
        ],
        "drivingLicense": [
          {
            "issuingCountry": "GB",
            "idNumber": "DLFAP3243AGHFD"
          }
        ],
        "passport": [
          {
            "issuingCountry": "GB",
            "idNumber": "H3243AGHFD"
          }
        ],
        "taxCode": [
          {
            "issuingCountry": "GB",
            "idNumber": "2363243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "Caroline House",
            "addressLine2": "55-57 High Holborn",
            "addressLine3": "Holborn",
            "addressLocality": "London",
            "addressRegion": null,
            "postalCode": "WC1V 6DX",
            "country": "UK",
            "longitude": null,
            "latitude": null,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "3 Edgar Buildings",
            "addressLine2": "86-92 Kingsway",
            "addressLine3": "Holborn",
            "addressLocality": "London",
            "addressRegion": null,
            "postalCode": "WC2B 6AA",
            "country": "UK",
            "longitude": null,
            "latitude": null,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": false
          },
          {
            "countryCode": "44",
            "telephoneNumber": "23462689567",
            "mobile": true,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "faxes": [
          {
            "countryCode": "44",
            "faxNumber": "11162689567",
            "contactType": "personal",
            "preferred": true
          },
          {
            "countryCode": "44",
            "faxNumber": "8888888888",
            "contactType": "work",
            "preferred": false
          }
        ]
      }
    },
    "relationships": {
      "ownerOf": {
        "data": [
          {
            "type": "vehicle",
            "id": "1GTEK24L7CJ551993",
            "meta": {
              "startTimestamp": "2015-12-11T08:50:15.735Z",
              "endTimestamp": "2016-10-18T11:13:55.604Z",
              "contractNumber": "1A2B3C"
            }
          }
        ]
      },
      "mainDriverOf": {
        "data": [
          {
            "type": "vehicle",
            "id": "FZFBE90E032466",
            "meta": {
              "startTimestamp": "2015-12-11T08:50:15.735Z",
              "endTimestamp": "2016-10-18T11:13:55.604Z",
              "contractNumber": "1B2456"
            }
          },
          {
            "type": "vehicle",
            "id": "FZFBE9E0032467",
            "meta": {
              "startTimestamp": "2018-06-01T08:50:15.735Z"
            }
          }
        ]
      },
      "contractorOf": {
        "data": [
          {
            "type": "vehicle",
            "id": "ZXXBE90E012345",
            "meta": {
              "startTimestamp": "2015-12-11T08:50:15.735Z",
              "endTimestamp": "2016-10-18T11:13:55.604Z",
              "contractNumber": "1A2B3D"
            }
          },
          {
            "type": "vehicle",
            "id": "ZBBBE90E012346"
          }
        ]
      },
      "contactPersonOf": {
        "data": [
          {
            "type": "vehicle",
            "id": "MNNNNE90E05986"
          }
        ]
      },
      "vehicleRegistrations": {
        "data": [
          {
            "type": "license-plate",
            "id": "ABS82Q"
          },
          {
            "type": "license-plate",
            "id": "ABC79F"
          }
        ]
      },
      "occasionalDriverOf": {
        "data": [
          {
            "id": "ZMTBZ28E80R025600",
            "type": "vehicle"
          }
        ]
      },
      "duplicateOf": {
        "data": [
          {
            "id": "7157960305",
            "type": "person",
            "nmscCode": "tgb",
            "sourceName": "portal"
          }
        ]
      }
    }
  }
}

Example implementation in javascript

// Import the eventsource library
const EventSource = require('eventsource');

// Set the relevant options, for API version and authentication
const options = {
  headers: {
    'accept-version': '~1.0.0',
    authorization: 'bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg'
  }
};

// The connection string
const nmscCode = 'tgb';
const sourceName = 'qube';
const endpoint = 'https://consumer-api.toyota-europe.com/';
const path = `/nmscCode/${nmscCode}/sourceName/${sourceName}/consumers/`;

// Create a server-sent events client
let es = new EventSource(`${endpoint}${path}`, options);

// Register event handlers
es.onopen = onOpen;
es.onerror = onError;
es.addEventListener('record', onRecord);

function onRecord (record) {
  console.log(`Event id: ${record.id}`);
  console.log(`Received record: ${JSON.stringify(record.data)}`);
  // You can process all the records in this function
}

function onOpen () {
  console.log('The connection opened');
}

// Treat errors
function onError (err) {
  if (err && (err.status === 401 || err.status === 403)) {
    console.log('Unauthorized');
  }
  console.log(err);
}

Types

Person

The consumer domain uses 3 different schemas. They are provided here as json-schema.

The schema allows for custom attributes to be placed inside the customProperties attribute. Consumer Domain does not make any special guarantees of the data stored here, but it does allow application specific consumer attributes to be stored in Consumer Domain. The API itself uses the lenient version of the schema. This strict schema is only made available for your convenience, it will not be used to determine whether a change to schema is considered breaking.

TYPE DEFINITION

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "/schemas/person.json",
  "title": "Consumer API Person Schema",
  "description": "This is a schema for person type responses and requests in the consumer API.",
  "$ref": "#/definitions/success",

  "definitions": {
    "success": {
      "type": "object",
      "required": [
        "data"
      ],
      "properties": {
        "data": {
          "$ref": "#/definitions/data"
        },
        "included": {
          "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
          "type": "array",
          "items": {
            "$ref": "#/definitions/resource"
          },
          "uniqueItems": true
        },
        "meta": {
          "$ref": "#/definitions/meta"
        },
        "links": {
          "description": "Link members related to the primary data.",
          "allOf": [
            {
              "$ref": "#/definitions/links"
            },
            {
              "$ref": "#/definitions/pagination"
            }
          ]
        },
        "jsonapi": {
          "$ref": "#/definitions/jsonapi"
        }
      },
      "additionalProperties": false
    },

    "meta": {
      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "format": "date-time"
        }
      },
      "additionalProperties": true
    },
    "data": {
      "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.",
      "oneOf": [
        {
          "$ref": "#/definitions/resource"
        },
        {
          "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/resource"
          },
          "uniqueItems": true
        }
      ]
    },
    "resource": {
      "description": "\"Resource objects\" appear in a JSON API document to represent resources.",
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": ["person"]
        },
        "id": {
          "type": ["string", "null"]
        },
        "attributes": {
          "$ref": "#/definitions/attributes"
        },
        "relationships": {
          "$ref": "#/definitions/relationships"
        },
        "links": {
          "$ref": "#/definitions/links"
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },

    "links": {
      "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
      "type": "object",
      "properties": {
        "self": {
          "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.",
          "type": "string",
          "format": "uri"
        },
        "related": {
          "$ref": "#/definitions/link"
        }
      },
      "additionalProperties": true
    },
    "link": {
      "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
      "oneOf": [
        {
          "description": "A string containing the link's URL.",
          "type": "string",
          "format": "uri"
        },
        {
          "type": "object",
          "required": [
            "href"
          ],
          "properties": {
            "href": {
              "description": "A string containing the link's URL.",
              "type": "string",
              "format": "uri"
            },
            "meta": {
              "$ref": "#/definitions/meta"
            }
          }
        }
      ]
    },

    "attributes": {
      "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.",
      "type": "object",
      "properties": {
        "givenName": {"$ref": "#/definitions/stringOrArray"},
        "middleName": {"$ref": "#/definitions/stringOrArray"},
        "familyName": {"$ref": "#/definitions/stringOrArray"},
        "familyName2": {"$ref": "#/definitions/stringOrArray"},
        "familyName3": {"$ref": "#/definitions/stringOrArray"},
        "firstInitial": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1
        },
        "honorificPrefix": {"$ref": "#/definitions/stringOrArray"},
        "honorificSuffix": {"$ref": "#/definitions/stringOrArray"},
        "gender": {
          "oneOf": [
            {
              "type": "string",
              "enum": ["male", "female"]
            },
            {
              "description": "An array of gender values",
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["male", "female"]
              },
              "uniqueItems": true
            }
          ]
        },
        "birthDate": {
          "type": "string",
          "pattern": "^[1-2][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$",
          "example": "1981-12-31"
        },
        "deceased": {
          "type": "boolean"
        },
        "deceasedDate": {
          "type": "string",
          "pattern": "^[1-2][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$",
          "example": "1981-12-31"
        },
        "profession": {
          "type": "string"
        },
        "civilStatus": {
          "type": "string",
          "enum": ["married", "single", "divorced", "widowed", "cohabiting"]
        },
        "nationality": {
          "oneOf": [
            {
              "$ref": "#/definitions/countryCode"
            },
            {
              "type": "array",
              "items": {"$ref": "#/definitions/countryCode"},
              "uniqueItems": true
            }
          ]
        },
        "preferredLanguage": {
          "type": "string",
          "description": "Language code following the ISO-639-1 standard."
        },
        "identifiers": {
          "type": "object",
          "properties": {
            "nationalId": {"$ref": "#/definitions/identifiers"},
            "drivingLicense": {"$ref": "#/definitions/identifiers"},
            "passport": {"$ref": "#/definitions/identifiers"},
            "taxCode": {"$ref": "#/definitions/identifiers"}
          },
          "patternProperties": {
            "^(?!relationships$|links$)\\w[-\\w_]*$": {
              "$ref": "#/definitions/identifiers"
            }
          },
          "additionalProperties": false
        },
        "contactPoints": {
          "type": "object",
          "properties": {
            "addresses": {
              "type": "array",
              "items": {"$ref": "#/definitions/address"},
              "uniqueItems": true
            },
            "emails": {
              "type": "array",
              "items": {"$ref": "#/definitions/email"},
              "uniqueItems": true
            },
            "telephones": {
              "type": "array",
              "items": {"$ref": "#/definitions/telephone"},
              "uniqueItems": true
            },
            "faxes": {
              "type": "array",
              "items": {"$ref": "#/definitions/fax"},
              "uniqueItems": true
            }
          }
        },
        "createdTimestamp": {
          "description": "Date and time indicating when the record was first created on the local system. Note that this does not indicate when the record was introduced to consumer domain.",
          "type": "string",
          "format": "date-time"
        },
        "lastUpdatedTimestamp": {
          "description": "Date and time indicating when the record was last updated on the local system. Note that this does not indicate when the record was updated on consumer domain (see meta.timestamp for that information instead).",
          "type": "string",
          "format": "date-time"
        },
        "verifiedTimestamp": {
          "description": "Date and time indicating if and when the record was verified. The means through which it was verified may differ between NMSCs and source-systems.",
          "type": "string",
          "format": "date-time"
        },
        "customProperties": {
          "type": "object",
          "description": "This property allows sources to save their own attributes in the consumer domain. CD does not provide any support for these attributes. This is a convenience feature.",
          "patternProperties": {
            "^(?!relationships$|links$)\\w[-\\w_]*$": {
              "description": "Attributes may contain any valid JSON value."
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },

    "relationships": {
      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
      "type": "object",
      "properties": {
        "mainDriverOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "occasionalDriverOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "ownerOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "contractorOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "financerOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "contactPersonOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "partnerOf": {
          "description": "One-to-one relationship, but due to merge rules an array can be returned",
          "anyOf": [
            {"$ref": "#/definitions/personRelationshipToOne"},
            {"$ref": "#/definitions/personRelationshipToMany"}
          ]
        },
        "childOf": {
          "$ref": "#/definitions/personRelationshipToMany"
        },
        "familyOf": {
          "$ref": "#/definitions/personRelationshipToMany"
        },
        "friendOf": {
          "$ref": "#/definitions/personRelationshipToMany"
        },
        "fleetManagerOf": {
          "$ref": "#/definitions/organizationRelationshipToMany"
        },
        "purchaseManagerOf": {
          "$ref": "#/definitions/organizationRelationshipToMany"
        },
        "accountsManagerOf": {
          "$ref": "#/definitions/organizationRelationshipToMany"
        },
        "ceoOf": {
          "$ref": "#/definitions/organizationRelationshipToMany"
        },
        "sourceRecords": {
          "oneOf": [{"$ref": "#/definitions/personRelationshipToMany"}, {"$ref": "#/definitions/organizationRelationshipToMany"}]
        },
        "orders": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "vehicleRegistrations": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "policyHolderOf": {
          "$ref": "#/definitions/relationshipToMany"
        },
        "guarantorOf": {
          "$ref": "#/definitions/mixedRelationshipToMany"
        },
        "proxyOf": {
          "$ref": "#/definitions/mixedRelationshipToMany"
        },
        "shareholderOf": {
          "$ref": "#/definitions/organizationRelationshipToMany"
        },
        "duplicateOf": {
          "$ref": "#/definitions/personRelationshipToMany"
        },
        "dealerVisibility": {
          "$ref": "#/definitions/dealerRelationshipToMany"
        },
        "preferredDealer": {
          "$ref": "#/definitions/dealerRelationshipToOne"
        }
      },
      "additionalProperties": false
    },
    "personRelationshipToMany": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "An array of pointers to the source-records that make up this consumer",
          "type": "array",
          "items": {
            "$ref": "#/definitions/personLinkage"
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "personRelationshipToOne": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
          "anyOf": [
            {
              "$ref": "#/definitions/empty"
            },
            {
              "$ref": "#/definitions/personLinkage"
            }
          ]
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "personLinkage": {
      "description": "A pointer to a source record",
      "type": "object",
      "required": ["id", "type", "sourceName", "nmscCode"],
      "properties": {
        "type": {"type": "string", "enum": ["person"]},
        "id": {"type": "string"},
        "meta": {"$ref": "#/definitions/relationshipMeta"},
        "sourceName": {"type": "string"},
        "nmscCode": {"$ref": "#/definitions/nmscCode"},
        "links": {"$ref": "#/definitions/links"}
      },
      "additionalProperties": false
    },
    "organizationRelationshipToMany": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "An array of pointers to the source-records that make up this consumer",
          "type": "array",
          "items": {
            "$ref": "#/definitions/organizationLinkage"
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "organizationRelationshipToOne": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
          "anyOf": [
            {
              "$ref": "#/definitions/empty"
            },
            {
              "$ref": "#/definitions/organizationLinkage"
            }
          ]
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "organizationLinkage": {
      "description": "A pointer to a source record",
      "type": "object",
      "required": ["id", "type", "sourceName", "nmscCode"],
      "properties": {
        "type": {"type": "string", "enum": ["organization"]},
        "id": {"type": "string"},
        "meta": {"$ref": "#/definitions/relationshipMeta"},
        "sourceName": {"type": "string"},
        "nmscCode": {"$ref": "#/definitions/nmscCode"},
        "links": {"$ref": "#/definitions/links"}
      },
      "additionalProperties": false
    },
    "dealerRelationshipToMany": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "An array of dealer references",
          "type": "array",
          "items": {
            "$ref": "#/definitions/dealerLinkage"
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "dealerRelationshipToOne": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
          "anyOf": [
            {
              "$ref": "#/definitions/empty"
            },
            {
              "$ref": "#/definitions/dealerLinkage"
            }
          ]
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "dealerLinkage": {
      "description": "A dealer, referenced to by its A2D UUID",
      "type": "object",
      "required": ["id", "type"],
      "properties": {
        "type": {"type": "string", "enum": ["dealer"]},
        "id": {"$ref": "#/definitions/a2dId"}
      },
      "additionalProperties": false
    },
    "mixedRelationshipToMany": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "An array of pointers to the source-records that make up this consumer",
          "type": "array",
          "items": {
            "oneOf": [{"$ref": "#/definitions/organizationLinkage"}, {"$ref": "#/definitions/personLinkage"}]
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "relationshipToOne": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
          "anyOf": [
            {
              "$ref": "#/definitions/empty"
            },
            {
              "$ref": "#/definitions/linkage"
            }
          ]
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "relationshipToMany": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/linkage"
          },
          "uniqueItems": true
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "empty": {
      "description": "Describes an empty to-one relationship.",
      "type": "null"
    },
    "linkage": {
      "description": "The \"type\" and \"id\" to non-empty members.",
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^(?!person$|organization$)\\w[-\\w_]*$"
        },
        "id": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/relationshipMeta"
        },
        "links": {"$ref": "#/definitions/links"}
      },
      "additionalProperties": false
    },
    "pagination": {
      "type": "object",
      "properties": {
        "first": {
          "description": "The first page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        },
        "last": {
          "description": "The last page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        },
        "prev": {
          "description": "The previous page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        },
        "next": {
          "description": "The next page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        }
      }
    },
    "jsonapi": {
      "description": "An object describing the server's implementation",
      "type": "object",
      "properties": {
        "version": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "identifier": {
      "type": "object",
      "required": ["issuingCountry", "idNumber"],
      "properties": {
        "issuingCountry": {
          "oneOf": [
            { "type": "null" },
            {"$ref": "#/definitions/countryCode"}
          ]
        },
        "idNumber": {"type": "string"}
      },
      "additionalProperties": false
    },
    "identifiers": {
      "type": "array",
      "items": {"$ref": "#/definitions/identifier"},
      "uniqueItems": true
    },
    "address": {
      "type": "object",
      "required": ["addressLine1", "addressLine2", "addressLine3", "addressLocality", "addressRegion", "postalCode", "country", "longitude", "latitude", "contactType"],
      "properties": {
        "addressLine1": {
          "type": ["string", "null"]
        },
        "addressLine2": {
          "type": ["string", "null"]
        },
        "addressLine3": {
          "type": ["string", "null"]
        },
        "addressLocality": {
          "description": "City or Muncipality or Town or relevant value",
          "type": ["string", "null"]
        },
        "addressRegion": {
          "description": "Region or County or State or relevant value",
          "type": ["string", "null"]
        },
        "postalCode": {
          "type": ["string", "null"]
        },
        "country": {
          "type": ["string", "null"]
        },
        "longitude": {
          "type": ["number", "null"]
        },
        "latitude": {
          "type": ["number", "null"]
        },
        "contactType": {"$ref": "#/definitions/contactType"},
        "preferred": {"type": "boolean"}
      },
      "additionalProperties": false
    },
    "email": {
      "type": "object",
      "required": ["contactType", "email"],
      "properties": {
        "contactType": {"$ref": "#/definitions/contactType"},
        "email": {
          "type": "string",
          "format": "email"
        },
        "preferred": {"type": "boolean"}
      },
      "additionalProperties": false
    },
    "fax": {
      "type": "object",
      "required": ["contactType", "countryCode", "faxNumber"],
      "properties": {
        "contactType": {"$ref": "#/definitions/contactType"},
        "countryCode": {
          "description": "Fax number country prefix without 00 or +",
          "type": ["string", "null"]
        },
        "faxNumber": {"type": "string"},
        "preferred": {"type": "boolean"}
      },
      "additionalProperties": false
    },
    "telephone": {
      "type": "object",
      "required": ["contactType", "countryCode", "telephoneNumber", "mobile"],
      "properties": {
        "contactType": {"$ref": "#/definitions/contactType"},
        "countryCode": {
          "description": "Telephone number country prefix without 00 or +",
          "type": ["string", "null"]
        },
        "telephoneNumber": {"type": "string"},
        "mobile": {"type": "boolean"},
        "preferred": {"type": "boolean"}
      },
      "additionalProperties": false
    },
    "contactType": {
      "type": ["string", "null"],
      "enum": ["personal", "work", null]
    },
    "stringOrArray": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "description": "An array of string",
          "type": "array",
          "items": {
            "type": "string"
          },
          "uniqueItems": true
        }
      ]
    },
    "countryCode": {
      "description": "2 digit ISO country code in upper case",
      "type": "string",
      "enum": ["AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CI", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "AX"]
    },
    "nmscCode": {
      "description": "3/4 digit NMSC code in lower case",
      "type": "string",
      "oneOf": [
        {"pattern": "^dojo"},
        {
          "enum": [
            "tad",
            "tau",
            "tba",
            "tbel",
            "tbu",
            "tca",
            "tce",
            "tcy",
            "tch",
            "tdg",
            "tdk",
            "tes",
            "tfr",
            "tfo",
            "tgb",
            "tgr",
            "thu",
            "tic",
            "til",
            "tir",
            "tmcz",
            "tmi",
            "tmkz",
            "tmr",
            "tnl",
            "tno",
            "tpl",
            "tpo",
            "tro",
            "tsk",
            "tsw",
            "ttk",
            "tuk"
          ]
        }
      ]
    },
    "relationshipMeta": {
      "description": "A meta object for relationships",
      "type": "object",
      "properties": {
        "startTimestamp": {
          "type": "string",
          "format": "date-time"
        },
        "endTimestamp": {
          "type": "string",
          "format": "date-time"
        },
        "contractNumber": {
          "type": "string",
          "description": "Depending on the relationship this could be an order number, finance contract number or an ID of the event that established this relationship"
        }
      },
      "additionalProperties": true
    },
    "uuid": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "example": "ef51a3fb-f2a5-4d16-9e1b-913184e7a68d"
    },
    "a2d": {
      "type": "string",
      "pattern": "^([0-9A-F]{5}-){5}[0-9A-F]$",
      "example": "00CD4-25F32-67C40-32C00-01340-3"
    },
    "a2dId": {
      "oneOf": [
        {"$ref": "#/definitions/a2d"},
        {"$ref": "#/definitions/uuid"}
      ]
    }
  }
}

Relationship

This is the schema for relationships in the consumer API.

TYPE DEFINITION

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "/schemas/relationship.json",
  "title": "Consumer API RelationshipType Schema",
  "description": "This is a schema for relationships in request for the consumer API.",
  "$ref": "#/definitions/relationships",

  "definitions": {
    "meta": {
      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
      "type": "object",
      "additionalProperties": true
    },
    "links": {
      "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
      "type": "object",
      "properties": {
        "self": {
          "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.",
          "type": "string",
          "format": "uri"
        },
        "related": {
          "$ref": "#/definitions/link"
        }
      },
      "additionalProperties": true
    },
    "link": {
      "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
      "oneOf": [
        {
          "description": "A string containing the link's URL.",
          "type": "string",
          "format": "uri"
        },
        {
          "type": "object",
          "required": [
            "href"
          ],
          "properties": {
            "href": {
              "description": "A string containing the link's URL.",
              "type": "string",
              "format": "uri"
            },
            "meta": {
              "$ref": "#/definitions/meta"
            }
          }
        }
      ]
    },

    "relationships": {
      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
      "type": "object",
      "required": ["data"],
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "Member, whose value represents \"resource linkage\".",
          "anyOf": [
            {"$ref": "#/definitions/relationshipToOne"},
            {"$ref": "#/definitions/relationshipToMany"},
            {"$ref": "#/definitions/personRelationshipToOne"},
            {"$ref": "#/definitions/personRelationshipToMany"},
            {"$ref": "#/definitions/organizationRelationshipToOne"},
            {"$ref": "#/definitions/organizationRelationshipToMany"},
            {"$ref": "#/definitions/mixedRelationshipToMany"}
          ]
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "relationshipToOne": {
      "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
      "anyOf": [
        {
          "$ref": "#/definitions/empty"
        },
        {
          "$ref": "#/definitions/linkage"
        }
      ]
    },
    "relationshipToMany": {
      "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/linkage"
      },
      "uniqueItems": true
    },
    "personRelationshipToOne": {
      "description": "References to other person resource objects in a to-one (\"relationship\").",
      "anyOf": [
        {
          "$ref": "#/definitions/empty"
        },
        {
          "$ref": "#/definitions/personLinkage"
        }
      ]
    },
    "personRelationshipToMany": {
      "description": "An array of objects each containing references members for to-many relationships.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/personLinkage"
      },
      "uniqueItems": true
    },
    "organizationRelationshipToOne": {
      "description": "References to other organization resource objects in a to-one (\"relationship\").",
      "anyOf": [
        {
          "$ref": "#/definitions/empty"
        },
        {
          "$ref": "#/definitions/organizationLinkage"
        }
      ]
    },
    "organizationRelationshipToMany": {
      "description": "An array of objects each containing references members for to-many relationships.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/organizationLinkage"
      },
      "uniqueItems": true
    },
    "mixedRelationshipToMany": {
      "description": "An array of objects each containing references members for to-many relationships.",
      "type": "array",
      "items": {
        "oneOf": [{"$ref": "#/definitions/organizationLinkage"}, {"$ref": "#/definitions/personLinkage"}]
      },
      "uniqueItems": true
    },
    "empty": {
      "description": "Describes an empty to-one relationship.",
      "type": "null"
    },
    "linkage": {
      "description": "The \"type\" and \"id\" to non-empty members.",
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^(?!person$|organization$)\\w[-\\w_]*$"
        },
        "id": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/relationshipMeta"
        },
        "links": {"$ref": "#/definitions/links"}
      },
      "additionalProperties": false
    },
    "personLinkage": {
      "description": "A pointer to a person source record",
      "type": "object",
      "required": ["id", "type", "sourceName", "nmscCode"],
      "properties": {
        "type": {"type": "string", "enum": ["person"]},
        "id": {"type": "string"},
        "meta": {"$ref": "#/definitions/relationshipMeta"},
        "sourceName": {"type": "string"},
        "nmscCode": {"$ref": "#/definitions/nmscCode"},
        "links": {"$ref": "#/definitions/links"}
      },
      "additionalProperties": false
    },
    "organizationLinkage": {
      "description": "A pointer to an organization source record",
      "type": "object",
      "required": ["id", "type", "sourceName", "nmscCode"],
      "properties": {
        "type": {"type": "string", "enum": ["organization"]},
        "id": {"type": "string"},
        "meta": {"$ref": "#/definitions/relationshipMeta"},
        "sourceName": {"type": "string"},
        "nmscCode": {"$ref": "#/definitions/nmscCode"},
        "links": {"$ref": "#/definitions/links"}
      },
      "additionalProperties": false
    },
    "dealerRelationshipToOne": {
        "description": "A dealer reference",
        "anyOf": [
          {
            "$ref": "#/definitions/empty"
          },
          {
            "$ref": "#/definitions/dealerLinkage"
          }
        ]
    },
    "dealerRelationshipToMany": {
      "properties": {
        "links": {
          "$ref": "#/definitions/links"
        },
        "data": {
          "description": "An array of dealer references",
          "type": "array",
          "items": {
            "$ref": "#/definitions/dealerLinkage"
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "dealerLinkage": {
      "description": "A dealer, referenced to by its A2D UUID",
      "type": "object",
      "required": ["id", "type"],
      "properties": {
        "type": {"type": "string", "enum": ["dealer"]},
        "id": {"$ref": "#/definitions/a2dId"}
      },
      "additionalProperties": false
    },
    "nmscCode": {
      "description": "3/4 digit NMSC code in lower case",
      "type": "string",
      "oneOf": [
        {"pattern": "^dojo"},
        {
          "enum": [
            "tad",
            "tau",
            "tba",
            "tbel",
            "tbu",
            "tca",
            "tce",
            "tcy",
            "tch",
            "tdg",
            "tdk",
            "tes",
            "tfr",
            "tfo",
            "tgb",
            "tgr",
            "thu",
            "tic",
            "til",
            "tir",
            "tmcz",
            "tmi",
            "tmkz",
            "tmr",
            "tnl",
            "tno",
            "tpl",
            "tpo",
            "tro",
            "tsk",
            "tsw",
            "ttk",
            "tuk"
          ]
        }
      ]
    },
    "relationshipMeta": {
      "description": "A meta object for relationships",
      "type": "object",
      "properties": {
        "startTimestamp": {
          "type": "string",
          "format": "date-time"
        },
        "endTimestamp": {
          "type": "string",
          "format": "date-time"
        },
        "contractNumber": {
          "type": "string",
          "description": "Depending on the relationship this could be an order number, finance contract number or an ID of the event that established this relationship"
        }
      },
      "additionalProperties": true
    },
    "uuid": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "example": "ef51a3fb-f2a5-4d16-9e1b-913184e7a68d"
    },
    "a2d": {
      "type": "string",
      "pattern": "^([0-9A-F]{5}-){5}[0-9A-F]$",
      "example": "00CD4-25F32-67C40-32C00-01340-3"
    },
    "a2dId": {
      "oneOf": [
        {"$ref": "#/definitions/a2d"},
        {"$ref": "#/definitions/uuid"}
      ]
    }
  }
}

Error

This is the schema for error responses in the consumer API.

TYPE DEFINITION

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "/schemas/error.json",
  "title": "Consumer API Error Schema",
  "description": "This is a schema for error responses in the consumer API.",
  "$ref": "#/definitions/failure",

  "definitions": {
    "failure": {
      "type": "object",
      "required": [
        "errors"
      ],
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/error"
          },
          "uniqueItems": true
        },
        "meta": {
          "$ref": "#/definitions/meta"
        },
        "jsonapi": {
          "$ref": "#/definitions/jsonapi"
        }
      },
      "additionalProperties": false
    },
    "meta": {
      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
      "type": "object",
      "additionalProperties": true
    },

    "jsonapi": {
      "description": "An object describing the server's implementation",
      "type": "object",
      "properties": {
        "version": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },

    "error": {
      "type": "object",
      "properties": {
        "id": {
          "description": "A unique identifier for this particular occurrence of the problem.",
          "type": "string"
        },
        "status": {
          "description": "The HTTP status code applicable to this problem, expressed as a string value.",
          "type": "string"
        },
        "code": {
          "description": "An application-specific error code, expressed as a string value.",
          "type": "string"
        },
        "title": {
          "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
          "type": "string"
        },
        "detail": {
          "description": "A human-readable explanation specific to this occurrence of the problem.",
          "type": "string"
        },
        "source": {
          "type": "object",
          "properties": {
            "pointer": {
              "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
              "type": "string"
            },
            "parameter": {
              "description": "A string indicating which query parameter caused the error.",
              "type": "string"
            }
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    }
  }
}

Delete

This is the schema for bulk delete request.

TYPE DEFINITION

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "/schemas/bulk-delete.json",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {"type": "string"}
        },
        "required": ["id"],
        "additionalProperties": false
      }
    }
  },
  "required": ["data"],
  "additionalProperties": false
}

JSON API response

This is the schema for responses in the JSON API format. For more info, see http://jsonapi.org.

TYPE DEFINITION

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "/schemas/jsonapi.json",
  "title": "JSON API Schema",
  "description": "This is a schema for responses in the JSON API format. For more, see https://jsonapi.org",
  "oneOf": [
    {
      "$ref": "#/definitions/success"
    },
    {
      "$ref": "#/definitions/failure"
    },
    {
      "$ref": "#/definitions/info"
    }
  ],

  "definitions": {
    "success": {
      "type": "object",
      "required": [
        "data"
      ],
      "properties": {
        "data": {
          "$ref": "#/definitions/data"
        },
        "included": {
          "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
          "type": "array",
          "items": {
            "$ref": "#/definitions/resource"
          },
          "uniqueItems": true
        },
        "meta": {
          "$ref": "#/definitions/meta"
        },
        "links": {
          "description": "Link members related to the primary data.",
          "allOf": [
            {
              "$ref": "#/definitions/links"
            },
            {
              "$ref": "#/definitions/pagination"
            }
          ]
        },
        "jsonapi": {
          "$ref": "#/definitions/jsonapi"
        }
      },
      "additionalProperties": false
    },
    "failure": {
      "type": "object",
      "required": [
        "errors"
      ],
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/error"
          },
          "uniqueItems": true
        },
        "meta": {
          "$ref": "#/definitions/meta"
        },
        "jsonapi": {
          "$ref": "#/definitions/jsonapi"
        }
      },
      "additionalProperties": false
    },
    "info": {
      "type": "object",
      "required": [
        "meta"
      ],
      "properties": {
        "meta": {
          "$ref": "#/definitions/meta"
        },
        "links": {
          "$ref": "#/definitions/links"
        },
        "jsonapi": {
          "$ref": "#/definitions/jsonapi"
        }
      },
      "additionalProperties": false
    },

    "meta": {
      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
      "type": "object",
      "additionalProperties": true
    },
    "data": {
      "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.",
      "oneOf": [
        {
          "$ref": "#/definitions/resource"
        },
        {
          "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/resource"
          },
          "uniqueItems": true
        }
      ]
    },
    "resource": {
      "description": "\"Resource objects\" appear in a JSON API document to represent resources.",
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "attributes": {
          "$ref": "#/definitions/attributes"
        },
        "relationships": {
          "$ref": "#/definitions/relationships"
        },
        "links": {
          "$ref": "#/definitions/links"
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },

    "links": {
      "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
      "type": "object",
      "properties": {
        "self": {
          "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.",
          "type": "string",
          "format": "uri"
        },
        "related": {
          "$ref": "#/definitions/link"
        }
      },
      "additionalProperties": true
    },
    "link": {
      "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
      "oneOf": [
        {
          "description": "A string containing the link's URL.",
          "type": "string",
          "format": "uri"
        },
        {
          "type": "object",
          "required": [
            "href"
          ],
          "properties": {
            "href": {
              "description": "A string containing the link's URL.",
              "type": "string",
              "format": "uri"
            },
            "meta": {
              "$ref": "#/definitions/meta"
            }
          }
        }
      ]
    },

    "attributes": {
      "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.",
      "type": "object",
      "patternProperties": {
        "^(?!relationships$|links$)\\w[-\\w_]*$": {
          "description": "Attributes may contain any valid JSON value."
        }
      },
      "additionalProperties": false
    },

    "relationships": {
      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
      "type": "object",
      "patternProperties": {
        "^\\w[-\\w_]*$": {
          "properties": {
            "links": {
              "$ref": "#/definitions/links"
            },
            "data": {
              "description": "Member, whose value represents \"resource linkage\".",
              "oneOf": [
                {
                  "$ref": "#/definitions/relationshipToOne"
                },
                {
                  "$ref": "#/definitions/relationshipToMany"
                }
              ]
            },
            "meta": {
              "$ref": "#/definitions/meta"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "relationshipToOne": {
      "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
      "anyOf": [
        {
          "$ref": "#/definitions/empty"
        },
        {
          "$ref": "#/definitions/linkage"
        }
      ]
    },
    "relationshipToMany": {
      "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/linkage"
      },
      "uniqueItems": true
    },
    "empty": {
      "description": "Describes an empty to-one relationship.",
      "type": "null"
    },
    "linkage": {
      "description": "The \"type\" and \"id\" to non-empty members.",
      "type": "object",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },
    "pagination": {
      "type": "object",
      "properties": {
        "first": {
          "description": "The first page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        },
        "last": {
          "description": "The last page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        },
        "prev": {
          "description": "The previous page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        },
        "next": {
          "description": "The next page of data",
          "oneOf": [
            { "type": "string", "format": "uri" },
            { "type": "null" }
          ]
        }
      }
    },

    "jsonapi": {
      "description": "An object describing the server's implementation",
      "type": "object",
      "properties": {
        "version": {
          "type": "string"
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    },

    "error": {
      "type": "object",
      "properties": {
        "id": {
          "description": "A unique identifier for this particular occurrence of the problem.",
          "type": "string"
        },
        "links": {
          "$ref": "#/definitions/links"
        },
        "status": {
          "description": "The HTTP status code applicable to this problem, expressed as a string value.",
          "type": "string"
        },
        "code": {
          "description": "An application-specific error code, expressed as a string value.",
          "type": "string"
        },
        "title": {
          "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
          "type": "string"
        },
        "detail": {
          "description": "A human-readable explanation specific to this occurrence of the problem.",
          "type": "string"
        },
        "source": {
          "type": "object",
          "properties": {
            "pointer": {
              "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
              "type": "string"
            },
            "parameter": {
              "description": "A string indicating which query parameter caused the error.",
              "type": "string"
            }
          }
        },
        "meta": {
          "$ref": "#/definitions/meta"
        }
      },
      "additionalProperties": false
    }
  }
}

API Endpoints

A view on a cluster of source records for all sources.

bulk consumers (for all sources) get

GET: /nmscCodes/{nmscCode}/consumers

Bulk extract to retrieve a paginated/stream based collection of all consumer objects which is filtered by nmscCode. The ids returned are those of the source system. Records without ids are new from the perspective of this source.

For an event stream response (in JavaScript, using https://www.npmjs.com/package/eventsource):

var EventSource = require('eventsource');
var options = {headers: {
  'authorization': 'bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg',
  'accept-version': '~1.0.0'
}};
var endpoint = 'https://consumer-api.toyota-europe.com/nmscCodes/tgb/consumers/?deltaFrom=2017-01-01T00:00:00.000Z';
var es = new EventSource(endpoint, options);
es.addEventListener('record', console.log);

URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

Header Parameters

last-event-id

The last event id that the client has processed. This allows you to resume a stream at a given offset. If this header is not set, the stream will be replayed from the start.

PropertyValue
requiredfalse
typestring

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

limit

Limit the number of records returned (maximum 500)

PropertyValue
requiredfalse
typeinteger
examples1

last-id

Skip over until the last-id if found

PropertyValue
requiredfalse
typestring
examples05d38fba4098c8531bacfe0da1e0e2ac697f4063

representation

The representation of the object that is required. This will determine the entity merge and standardisation rules applied to the data

PropertyValue
requiredfalse
typestring
examplesdefault

deltaFrom

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deltaTo

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

filter

Filter out deleted clusters, only show deleted clusters or retrieve all types of clusters (Version 1.4.0 and higher).

PropertyValue
requiredfalse
typestring
oneOfregular, deleted, all
examplesregular

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

204

The request was successful, but there is no more data. The client should not try to reconnect

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk consumers (for all sources) get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/consumers?limit=1&last-id=05d38fba4098c8531bacfe0da1e0e2ac697f4063&representation=default&deltaFrom=2017-01-01T00:00:00.000Z&deltaTo=2017-01-01T00:00:00.000Z&filter=regular&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "data": [{
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      },
      "sourceRecords": {
        "data": [
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "12345",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/source-records/12345"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/ce35c200-7623-11e4-82f8-0800200c9a66"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-web-forms",
            "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-web-forms/e3d6919e-b123-4bf5-b769-67b44a39b24e"}
          }
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }],
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/consumers/?limit=1&deltaFrom=2017-01-01T00:00:00.000Z",
    "first": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/consumers/?limit=1&deltaFrom=2017-01-01T00:00:00.000Z",
    "next": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/consumers/?limit=1&deltaFrom=2017-01-01T00:00:00.000Z&last-id=ce35c200-7623-11e4-82f8-0800200c9a66"
  }
}
Type
Person
Example
id: ce35c200-7623-11e4-82f8-0800200c9a66
event: record
data: {
  "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
  "type": "person",
  "relationships": {
    "ownerOf": {
      "data": [
        {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
      ]
    },
    "sourceRecords": {
      "data": [
        {
          "nmscCode": "tgb",
          "type": "person",
          "sourceName": "tgb-crm",
          "id": "12345",
          "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/source-records/12345"}
        },
        {
          "nmscCode": "tgb",
          "type": "person",
          "sourceName": "tgb-crm",
          "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
          "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/ce35c200-7623-11e4-82f8-0800200c9a66"}
        },
        {
          "nmscCode": "tgb",
          "type": "person",
          "sourceName": "tgb-web-forms",
          "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e",
          "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-web-forms/e3d6919e-b123-4bf5-b769-67b44a39b24e"}
        }
      ]
    }
  },
  "attributes": {
    "givenName": "Christopher",
    "familyName": "Smith",
    "honorificPrefix": "Mr",
    "gender": "male",
    "nationality": "GB",
    "identifiers": {
      "nationalId": [
        {
          "issuingCountry": "FR",
          "idNumber": "34563243AGHFD"
        }
      ]
    },
    "contactPoints": {
      "addresses": [
        {
          "addressLine1": "60 Avenue du Bourget",
          "addressLine2": "Bourgetlaan 60",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "work",
          "preferred": false
        },
        {
          "addressLine1": "Grote Markt 1",
          "addressLine2": "Grand Place 1",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "personal",
          "preferred": true
        }
      ],
      "emails": [
        {
          "contactType": "personal",
          "email": "christopher.smith@somecompany.com",
          "preferred": true
        },
        {
          "contactType": "work",
          "email": "cscasd32e@gmail.com",
          "preferred": false
        }
      ],
      "telephones": [
        {
          "countryCode": "44",
          "telephoneNumber": "01162689567",
          "mobile": false,
          "contactType": "personal",
          "preferred": true
        }
      ]
    }
  }
}

Type: any

RESPONSE BODY

consumer (persistent ID) get

GET: /nmscCodes/{nmscCode}/consumers/{persistentId}

Retrieve a specific consumer by persistentId

Rather than requesting a consumer through a source-record ID, you may also request it using a persistent ID, which will remain consistent even if the underlying cluster composition changes.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

persistentId

The consumer's persistent ID

PropertyValue
requiredtrue
typestring
examples2d7398b9-5160-30a9-85c2-b8ddef4242cb

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

representation

The representation of the object that is required. This will determine the entity merge and standardisation rules applied to the data

PropertyValue
requiredfalse
typestring
examplesdefault

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

consumer (persistent ID) get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/consumers/{persistentId}?representation=default&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/consumers/2d7398b9-5160-30a9-85c2-b8ddef4242cb"
  },
  "data": {
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "persistentId": "2d7398b9-5160-30a9-85c2-b8ddef4242cb",
    "type": "person",
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      },
      "sourceRecords": {
        "data": [
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "12345",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/source-records/12345"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/ce35c200-7623-11e4-82f8-0800200c9a66"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-web-forms",
            "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-web-forms/e3d6919e-b123-4bf5-b769-67b44a39b24e"}
          }
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }
}
Type
Person

A view on a cluster of source records for a specific source. This is our best representation of a given person at a given point in time. Cannot be updated directly

bulk consumers get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/consumers

Retrieve a paginated collection of all consumer objects which is filtered by nmscCode. The ids returned are those of the source system. Records without ids are new from the perspective of this source.

For an event stream response (in JavaScript, using https://www.npmjs.com/package/eventsource):

var EventSource = require('eventsource');
var options = {headers: {
  'authorization': 'bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg',
  'accept-version': '~1.0.0'
}};
var endpoint = 'https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/?deltaFrom=2017-01-01T00:00:00.000Z';
var es = new EventSource(endpoint, options);
es.addEventListener('record', console.log);

URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

Header Parameters

last-event-id

The last event id that the client has processed. This allows you to resume a stream at a given offset. If this header is not set, the stream will be replayed from the start.

PropertyValue
requiredfalse
typestring

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

limit

Limit the number of records returned (maximum 500)

PropertyValue
requiredfalse
typeinteger
examples1

last-id

Skip over until the last-id if found

PropertyValue
requiredfalse
typestring
examples05d38fba4098c8531bacfe0da1e0e2ac697f4063

representation

The representation of the object that is required. This will determine the entity merge and standardisation rules applied to the data

PropertyValue
requiredfalse
typestring
examplesdefault

deltaFrom

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deltaTo

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

204

The request was successful, but there is no more data. The client should not try to reconnect

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk consumers get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/consumers?limit=1&last-id=05d38fba4098c8531bacfe0da1e0e2ac697f4063&representation=default&deltaFrom=2017-01-01T00:00:00.000Z&deltaTo=2017-01-01T00:00:00.000Z&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "data": [{
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "links": {
      "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66",
      "source-record": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66"
    },
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      },
      "sourceRecords": {
        "data": [
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "12345",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/source-records/12345"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/ce35c200-7623-11e4-82f8-0800200c9a66"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-web-forms",
            "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-web-forms/e3d6919e-b123-4bf5-b769-67b44a39b24e"}
          }
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }],
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/?limit=1&deltaFrom=2017-01-01T00:00:00.000Z",
    "first": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/?limit=1&deltaFrom=2017-01-01T00:00:00.000Z",
    "next": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/?limit=1&deltaFrom=2017-01-01T00:00:00.000Z&last-id=e3d6919e-b123-4bf5-b769-67b44a39b24e"
  }
}
Type
Person
Example
id: ce35c200-7623-11e4-82f8-0800200c9a66
event: record
data: {
  "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
  "type": "person",
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66"
  },
  "relationships": {
    "ownerOf": {
      "data": [
        {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
      ]
    },
    "sourceRecords": {
      "data": [
        {
          "nmscCode": "tgb",
          "type": "person",
          "sourceName": "tgb-crm",
          "id": "12345",
          "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/source-records/12345"}
        },
        {
          "nmscCode": "tgb",
          "type": "person",
          "sourceName": "tgb-crm",
          "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
          "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/ce35c200-7623-11e4-82f8-0800200c9a66"}
        },
        {
          "nmscCode": "tgb",
          "type": "person",
          "sourceName": "tgb-web-forms",
          "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e",
          "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-web-forms/e3d6919e-b123-4bf5-b769-67b44a39b24e"}
        }
      ]
    }
  },
  "attributes": {
    "givenName": "Christopher",
    "familyName": "Smith",
    "honorificPrefix": "Mr",
    "gender": "male",
    "nationality": "GB",
    "identifiers": {
      "nationalId": [
        {
          "issuingCountry": "FR",
          "idNumber": "34563243AGHFD"
        }
      ]
    },
    "contactPoints": {
      "addresses": [
        {
          "addressLine1": "60 Avenue du Bourget",
          "addressLine2": "Bourgetlaan 60",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "work",
          "preferred": false
        },
        {
          "addressLine1": "Grote Markt 1",
          "addressLine2": "Grand Place 1",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "personal",
          "preferred": true
        }
      ],
      "emails": [
        {
          "contactType": "personal",
          "email": "christopher.smith@somecompany.com",
          "preferred": true
        },
        {
          "contactType": "work",
          "email": "cscasd32e@gmail.com",
          "preferred": false
        }
      ],
      "telephones": [
        {
          "countryCode": "44",
          "telephoneNumber": "01162689567",
          "mobile": false,
          "contactType": "personal",
          "preferred": true
        }
      ]
    }
  }
}

Type: any

RESPONSE BODY

consumer get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/consumers/{sourceId}

Retrieve a specific consumer by sourceId


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

representation

The representation of the object that is required. This will determine the entity merge and standardisation rules applied to the data

PropertyValue
requiredfalse
typestring
examplesdefault

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

clusteredOnly

Parameter to prevent pretend cluster.
By default, requesting the consumer for an unclustered source-record will return a response consistent with a singleton cluster (e.g. a cluster containing only that source-record). By enabling this option, a 404 response would be returned for this case instead.

PropertyValue
requiredfalse
typestring
examplestrue

Possible Responses

200

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

consumer get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/consumers/{sourceId}?representation=default&version=~1.2.0&clusteredOnly=true" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66",
    "source-record": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66"
  },
  "data": {
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      },
      "sourceRecords": {
        "data": [
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "12345",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/source-records/12345"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-crm",
            "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-crm/ce35c200-7623-11e4-82f8-0800200c9a66"}
          },
          {
            "nmscCode": "tgb",
            "type": "person",
            "sourceName": "tgb-web-forms",
            "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e",
            "links": {"self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/tgb-web-forms/e3d6919e-b123-4bf5-b769-67b44a39b24e"}
          }
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }
}
Type
Person

consumer relationship get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/consumers/{sourceId}/{relationshipType}

Get a list of entities related to this consumer with this relationshipType.
If the consumer has no entities linked with this type, an empty list will be returned


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

relationshipType

The type of relationship this consumer has with the entity

PropertyValue
requiredtrue
typestring
oneOfaccountsManagerOf, ceoOf, childOf, contactPersonOf, contractorOf, familyOf, financerOf, fleetManagerOf, friendOf, guarantorOf, mainDriverOf, occasionalDriverOf, orders, ownerOf, partnerOf, policyHolderOf, preferredDealer, proxyOf, purchaseManagerOf, shareholderOf, sourceRecords, vehicleRegistrations
examplesownerOf

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

representation

The representation of the object that is required. This will determine the entity merge and standardisation rules applied to the data

PropertyValue
requiredfalse
typestring
examplesdefault

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

consumer relationship get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/consumers/{sourceId}/{relationshipType}?representation=default&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66/ownerOf"
  },
  "data": [
    {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
  ]
}
Type
Jsonapi

source records for all sources.

bulk source-records (for all sources) get

GET: /nmscCodes/{nmscCode}/source-records

Retrieve a paginated collection of source records for all sources.

For an event stream response (in JavaScript, using https://www.npmjs.com/package/eventsource):

  var EventSource = require('eventsource');
  var options = {headers: {
    'authorization': 'bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg',
    'accept-version': '~1.0.0'
  }};
  var endpoint = 'https://consumer-api.toyota-europe.com/nmscCodes/tgb/source-records/';
  var es = new EventSource(endpoint, options);
  es.addEventListener('record', console.log);

URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

Header Parameters

last-event-id

The last event id that the client has processed. This allows you to resume a stream at a given offset. If this header is not set, the stream will be replayed from the start.

PropertyValue
requiredfalse
typestring

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

limit

Limit the number of records returned (maximum 500)

PropertyValue
requiredfalse
typeinteger
examples1

last-id

Skip over until the last-id if found

PropertyValue
requiredfalse
typestring
examples05d38fba4098c8531bacfe0da1e0e2ac697f4063

deltaFrom

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deltaTo

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deleted

Use this flag to retrieve only deleted source-records.

PropertyValue
requiredfalse
typeboolean
examplesfalse

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

204

The request was successful, but there is no more data. The client should not try to reconnect

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk source-records (for all sources) get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/source-records?limit=1&last-id=05d38fba4098c8531bacfe0da1e0e2ac697f4063&deltaFrom=2017-01-01T00:00:00.000Z&deltaTo=2017-01-01T00:00:00.000Z&deleted=false&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "data": [{
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "links": {
      "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66",
      "consumer": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66"
    },
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }],
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/source-records/?limit=1",
    "first": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/source-records/?limit=1",
    "next": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/source-records/?limit=1&last-id=ce35c200-7623-11e4-82f8-0800200c9a66"
  }
}
Type
Person
Example
id: ce35c200-7623-11e4-82f8-0800200c9a66
event: record
data: {
  "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
  "type": "person",
  "links": {
  "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66",
  "consumer":"https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66"
  },
  "relationships": {
    "ownerOf": {
      "data": [
        {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
      ]
    },
    "sourceRecords": {
      "data": [
        {"nmscCode": "tgb", "type": "person", "sourceName": "tgb-crm", "id": "12345"},
        {"nmscCode": "tgb", "type": "person", "sourceName": "tgb-crm", "id": "ce35c200-7623-11e4-82f8-0800200c9a66"},
        {"nmscCode": "tgb", "type": "person", "sourceName": "tgb-web-forms", "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e"}
      ]
    }
  },
  "attributes": {
    "givenName": "Christopher",
    "familyName": "Smith",
    "honorificPrefix": "Mr",
    "gender": "male",
    "nationality": "GB",
    "identifiers": {
      "nationalId": [
        {
          "issuingCountry": "FR",
          "idNumber": "34563243AGHFD"
        }
      ]
    },
    "contactPoints": {
      "addresses": [
        {
          "addressLine1": "60 Avenue du Bourget",
          "addressLine2": "Bourgetlaan 60",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "work",
          "preferred": false
        },
        {
          "addressLine1": "Grote Markt 1",
          "addressLine2": "Grand Place 1",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "personal",
          "preferred": true
        }
      ],
      "emails": [
        {
          "contactType": "personal",
          "email": "christopher.smith@somecompany.com",
          "preferred": true
        },
        {
          "contactType": "work",
          "email": "cscasd32e@gmail.com",
          "preferred": false
        }
      ],
      "telephones": [
        {
          "countryCode": "44",
          "telephoneNumber": "01162689567",
          "mobile": false,
          "contactType": "personal",
          "preferred": true
        }
      ]
    }
  }
}

Type: any

RESPONSE BODY

A person record from a source system. Contains the representation of a person for this particular source system. These records get grouped and can be consumed as consumers

bulk source-records get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records

Retrieve a paginated collection of all source records for this source.

For an event stream response (in JavaScript, using https://www.npmjs.com/package/eventsource):

  var EventSource = require('eventsource');
  var options = {headers: {
    'authorization': 'bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg',
    'accept-version': '~1.0.0'
  }};
  var endpoint = 'https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/';
  var es = new EventSource(endpoint, options);
  es.addEventListener('record', console.log);

URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

Header Parameters

last-event-id

The last event id that the client has processed. This allows you to resume a stream at a given offset. If this header is not set, the stream will be replayed from the start.

PropertyValue
requiredfalse
typestring

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

limit

Limit the number of records returned (maximum 500)

PropertyValue
requiredfalse
typeinteger
examples1

last-id

Skip over until the last-id if found

PropertyValue
requiredfalse
typestring
examples05d38fba4098c8531bacfe0da1e0e2ac697f4063

deltaFrom

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deltaTo

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deleted

Use this flag to retrieve only deleted source-records.

PropertyValue
requiredfalse
typeboolean
examplesfalse

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

204

The request was successful, but there is no more data. The client should not try to reconnect

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk source-records get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records?limit=1&last-id=05d38fba4098c8531bacfe0da1e0e2ac697f4063&deltaFrom=2017-01-01T00:00:00.000Z&deltaTo=2017-01-01T00:00:00.000Z&deleted=false&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "data": [{
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "links": {
      "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66",
      "consumer": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66"
    },
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }],
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/?limit=1",
    "first": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/?limit=1",
    "next": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/?limit=1&last-id=ce35c200-7623-11e4-82f8-0800200c9a66"
  }
}
Type
Person
Example
id: ce35c200-7623-11e4-82f8-0800200c9a66
event: record
data: {
  "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
  "type": "person",
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66",
    "consumer":"https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66"
  },
  "relationships": {
    "ownerOf": {
      "data": [
        {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
      ]
    },
    "sourceRecords": {
      "data": [
        {"nmscCode": "tgb", "type": "person", "sourceName": "tgb-crm", "id": "12345"},
        {"nmscCode": "tgb", "type": "person", "sourceName": "tgb-crm", "id": "ce35c200-7623-11e4-82f8-0800200c9a66"},
        {"nmscCode": "tgb", "type": "person", "sourceName": "tgb-web-forms", "id": "e3d6919e-b123-4bf5-b769-67b44a39b24e"}
      ]
    }
  },
  "attributes": {
    "givenName": "Christopher",
    "familyName": "Smith",
    "honorificPrefix": "Mr",
    "gender": "male",
    "nationality": "GB",
    "identifiers": {
      "nationalId": [
        {
          "issuingCountry": "FR",
          "idNumber": "34563243AGHFD"
        }
      ]
    },
    "contactPoints": {
      "addresses": [
        {
          "addressLine1": "60 Avenue du Bourget",
          "addressLine2": "Bourgetlaan 60",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "work",
          "preferred": false
        },
        {
          "addressLine1": "Grote Markt 1",
          "addressLine2": "Grand Place 1",
          "addressLine3": null,
          "addressLocality": "Brussels",
          "addressRegion": null,
          "postalCode": "1140",
          "country": "Belgium",
          "longitude": 50.878622,
          "latitude": 4.435,
          "contactType": "personal",
          "preferred": true
        }
      ],
      "emails": [
        {
          "contactType": "personal",
          "email": "christopher.smith@somecompany.com",
          "preferred": true
        },
        {
          "contactType": "work",
          "email": "cscasd32e@gmail.com",
          "preferred": false
        }
      ],
      "telephones": [
        {
          "countryCode": "44",
          "telephoneNumber": "01162689567",
          "mobile": false,
          "contactType": "personal",
          "preferred": true
        }
      ]
    }
  }
}

Type: any

RESPONSE BODY

bulk source-records patch

PATCH: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records

Bulk update an array of consumer.
For systems where the consumer domain is not the system of record, this will perform a bulk upsert.
Maps are recursively merged.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

204

Update successful

400

One or more errors occurred while processing the request. Inspect the response for more information. All records must pass input validation before any processing will take place.

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk source-records patch

CURL EXAMPLE

curl -X PATCH "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg" \
	-d @request_body

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": [
    {
      "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
      "type": "person",
      "attributes": {
        "givenName": "Christopher"
      }
    },
    {
      "id": "7a51ad56-d756-4c91-b69c-de12c3cd4356",
      "type": "person",
      "attributes": {
        "contactPoints": {
          "email": [{
            "contactType": "work",
            "email": "dude@somecompany.com",
            "preferred": false
          }]
        }
      }
    }
  ]
}
Type
Person

RESPONSE BODY

source-record post

POST: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records

Create a new source-record.
This method is only available if the consumer domain creates IDs for this sourceName.
The id attribute in the payload should either be set to null or not be present.

See Single source-record payload for an elaborate example payload.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

201

Source record has been created.

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record post

CURL EXAMPLE

curl -X POST "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg" \
	-d @request_body

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": {
    "id": null,
    "type": "person",
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "contactPoints": {
        "email": [
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ]
      }
    }
  }
}
Type
Person

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66",
    "consumer": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66"
  },
  "data": {
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }
}
Type
Person

bulk source-records delete

DELETE: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records

Bulk delete of source-records for a given source.

Request body should contain set of Id's as per delete schema format. The delete is successful only when an entire batch is processed. Within a batch, if one of the entry is failed with missing Id validation error (i.e. not existing in DB), then the complete batch is rejected for further processing.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

204

delete successful

403

You are not allowed to perform this operation

404

unsuccessful due to non-existing ids.

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk source-records delete

CURL EXAMPLE

curl -X DELETE "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": [
    {
      "id": "ce35c200-7623-11e4-82f8-0800200c9a66"
    },
    {
      "id": "7a51ad56-d756-4c91-b69c-de12c3cd4356"
    }
  ]
}
Type
Delete

RESPONSE BODY

source-record get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}

Retrieve a specific source-record by sourceId.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/source-records/ce35c200-7623-11e4-82f8-0800200c9a66",
    "consumer": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66"
  },
  "data": {
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "relationships": {
      "ownerOf": {
        "data": [
          {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
        ]
      }
    },
    "attributes": {
      "givenName": "Christopher",
      "familyName": "Smith",
      "honorificPrefix": "Mr",
      "gender": "male",
      "nationality": "GB",
      "identifiers": {
        "nationalId": [
          {
            "issuingCountry": "FR",
            "idNumber": "34563243AGHFD"
          }
        ]
      },
      "contactPoints": {
        "addresses": [
          {
            "addressLine1": "60 Avenue du Bourget",
            "addressLine2": "Bourgetlaan 60",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "work",
            "preferred": false
          },
          {
            "addressLine1": "Grote Markt 1",
            "addressLine2": "Grand Place 1",
            "addressLine3": null,
            "addressLocality": "Brussels",
            "addressRegion": null,
            "postalCode": "1140",
            "country": "Belgium",
            "longitude": 50.878622,
            "latitude": 4.435,
            "contactType": "personal",
            "preferred": true
          }
        ],
        "emails": [
          {
            "contactType": "personal",
            "email": "christopher.smith@somecompany.com",
            "preferred": true
          },
          {
            "contactType": "work",
            "email": "cscasd32e@gmail.com",
            "preferred": false
          }
        ],
        "telephones": [
          {
            "countryCode": "44",
            "telephoneNumber": "01162689567",
            "mobile": false,
            "contactType": "personal",
            "preferred": true
          }
        ]
      }
    }
  }
}
Type
Person

source-record patch

PATCH: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}

Update a specific source-record by sourceId.
This acts as an upsert if the consumer domain is not the system of record for this sources data.
Maps are recursively merged.

See Single source-record payload for an elaborate example payload.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

201

Record created

204

Update successful

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record patch

CURL EXAMPLE

curl -X PATCH "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg" \
	-d @request_body

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": {
    "id": "ce35c200-7623-11e4-82f8-0800200c9a66",
    "type": "person",
    "attributes": {
      "givenName": "Christopher"
    }
  }
}
Type
Person

RESPONSE BODY

RESPONSE BODY

source-record delete

DELETE: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}

Delete a specific source-record by sourceId.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

204

Delete successful

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record delete

CURL EXAMPLE

curl -X DELETE "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

source-record relationships patch

PATCH: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/relationships/{relationshipType}

Replace all the entities linked to this person with this relationshipType, with the list of entities in this call.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

relationshipType

The type of relationship this consumer has with the entity

PropertyValue
requiredtrue
typestring
oneOfaccountsManagerOf, ceoOf, childOf, contactPersonOf, contractorOf, familyOf, financerOf, fleetManagerOf, friendOf, guarantorOf, mainDriverOf, occasionalDriverOf, orders, ownerOf, partnerOf, policyHolderOf, preferredDealer, proxyOf, purchaseManagerOf, shareholderOf, vehicleRegistrations
examplesownerOf

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

204

Update successful

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record relationships patch

CURL EXAMPLE

curl -X PATCH "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/relationships/{relationshipType}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg" \
	-d @request_body

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": [
    {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}},
    {"type": "vehicle", "id": "some-other-vin"}
  ]
}
Type
Relationship

RESPONSE BODY

source-record relationships post

POST: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/relationships/{relationshipType}

Add a relationship of relationshipType with a number of entities. This only works for one-to-many relationships. Trying to add one-to-one relationships this way will return 403.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

relationshipType

The type of relationship this consumer has with the entity

PropertyValue
requiredtrue
typestring
oneOfaccountsManagerOf, ceoOf, childOf, contactPersonOf, contractorOf, familyOf, financerOf, fleetManagerOf, friendOf, guarantorOf, mainDriverOf, occasionalDriverOf, orders, ownerOf, partnerOf, policyHolderOf, preferredDealer, proxyOf, purchaseManagerOf, shareholderOf, vehicleRegistrations
examplesownerOf

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

204

Add successful

403

Cannot add relationships to a one-to-one relationship

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record relationships post

CURL EXAMPLE

curl -X POST "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/relationships/{relationshipType}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg" \
	-d @request_body

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": [
    {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}},
    {"type": "vehicle", "id": "some-other-vin"}
  ]
}
Type
Relationship

RESPONSE BODY

source-record relationships delete

DELETE: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/relationships/{relationshipType}

Remove a relationship with a number of entities. This only works for one-to-many relationships. Trying to remove one-to-one relationships this way will return 403.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

relationshipType

The type of relationship this consumer has with the entity

PropertyValue
requiredtrue
typestring
oneOfaccountsManagerOf, ceoOf, childOf, contactPersonOf, contractorOf, familyOf, financerOf, fleetManagerOf, friendOf, guarantorOf, mainDriverOf, occasionalDriverOf, orders, ownerOf, partnerOf, policyHolderOf, preferredDealer, proxyOf, purchaseManagerOf, shareholderOf, vehicleRegistrations
examplesownerOf

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

204

Delete successful

403

Cannot remove relationships to a one-to-one relationship

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record relationships delete

CURL EXAMPLE

curl -X DELETE "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/relationships/{relationshipType}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

REQUEST BODY

Example
{
  "data": [
    {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}},
    {"type": "vehicle", "id": "some-other-vin"}
  ]
}
Type
Relationship

RESPONSE BODY

source-record relationship get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/{relationshipType}

Get a list of entities related to this source-record with this relationshipType. If the consumer has no entities linked with this type, an empty list will be returned.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

sourceId

The ID of this particular source record

PropertyValue
requiredtrue
typestring

relationshipType

The type of relationship this consumer has with the entity

PropertyValue
requiredtrue
typestring
oneOfaccountsManagerOf, ceoOf, childOf, contactPersonOf, contractorOf, familyOf, financerOf, fleetManagerOf, friendOf, guarantorOf, mainDriverOf, occasionalDriverOf, orders, ownerOf, partnerOf, policyHolderOf, preferredDealer, proxyOf, purchaseManagerOf, shareholderOf, vehicleRegistrations
examplesownerOf

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

403

You are not allowed to perform this operation

404

No customer with this ID exists

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

source-record relationship get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/source-records/{sourceId}/{relationshipType}?version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/consumers/ce35c200-7623-11e4-82f8-0800200c9a66/ownerOf"
  },
  "data": [
    {"type": "vehicle", "id": "1GTEK24L7CJ551993", "meta": {"startTimestamp": "2015-12-11T08:50:15.735Z", "endTimestamp": "2016-10-18T11:13:55.604Z", "contractNumber": "1A2B3C"}}
  ]
}
Type
Jsonapi

statistics (NMSC) get

GET: /nmscCodes/{nmscCode}/statistics

Get counts of source-records and clusters, at the NMSC level and for each source system individually.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

deltaFrom

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deltaTo

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

Possible Responses

200

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

statistics (NMSC) get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/statistics?version=~1.2.0&deltaFrom=2017-01-01T00:00:00.000Z&deltaTo=2017-01-01T00:00:00.000Z" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/statistics?deltaFrom=2017-01-01T00:00:00.000Z"
  },
  "data": {
    "source-records": {
      "total": 100,
      "sources": {
        "tgb-crm": {
          "total": 68
        },
        "tgb-web-forms": {
          "total": 32
        }
      }
    },
    "clusters": {
      "total": 50,
      "sources": {
        "tgb-crm": {
          "total": 44
        },
        "tgb-web-forms": {
          "total": 27
        }
      }
    }
  }
}
Type
Jsonapi

statistics (source system) get

GET: /nmscCodes/{nmscCode}/sourceNames/{sourceName}/statistics

Get a count of source-records and clusters at the source system level.


URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

sourceName

The name of the source system. This acts as a namespace on the sourceId

PropertyValue
requiredtrue
typestring
examplesportal

Header Parameters

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

deltaFrom

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

deltaTo

Retrieve delta records based on the UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ)

PropertyValue
requiredfalse
typedatetime
examples2017-01-01T00:00:00.000Z

Possible Responses

200

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

statistics (source system) get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/sourceNames/{sourceName}/statistics?version=~1.2.0&deltaFrom=2017-01-01T00:00:00.000Z&deltaTo=2017-01-01T00:00:00.000Z" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
  "links": {
    "self": "https://consumer-api.toyota-europe.com/nmscCodes/tgb/sourceNames/person_crm/statistics?deltaFrom=2017-01-01T00:00:00.000Z"
  },
  "data": {
    "source-records": {
      "total": 100
    },
    "clusters": {
      "total": 50
    }
  }
}
Type
Jsonapi

bulk clusters get

GET: /nmscCodes/{nmscCode}/clusters

Bulk extract to retrieve a paginated/stream based collection of all cluster compositions which is filtered by nmscCode and scenario. The record ids returned are those of the source system.

For an event stream response (in JavaScript, using https://www.npmjs.com/package/eventsource):

var EventSource = require('eventsource');
var options = {headers: {
  'authorization': 'bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg',
  'accept-version': '~1.0.0'
}};
var endpoint = 'https://consumer-api.toyota-europe.com/nmscCodes/tgb/clusters/?scenario=crm';
var es = new EventSource(endpoint, options);
es.addEventListener('record', console.log);

URI Parameters

nmscCode

The NMSC short code in lowercase

PropertyValue
requiredtrue
typestring
oneOftfr, thu, tes, tbu, tmkz, tau, tuk, tcy, tsk, tic, tgb, tmcz, tmi, tmr, tro, tca, tpo, tba, tno, tbel, tdg, tsw, tch, tdk, tfo, tir, tgr, tad, tpl, til
examplestgb

Header Parameters

last-event-id

The last event id that the client has processed. This allows you to resume a stream at a given offset. If this header is not set, the stream will be replayed from the start.

PropertyValue
requiredfalse
typestring

Accept-Version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this header or the queryParameter can be used to indicate the version. This parameter has lower priority than the queryParameter version.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Authorization

A valid OAuth2 token.

PropertyValue
requiredtrue
typestring
examplesbearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

Query Parameters

limit

Limit the number of records returned (maximum 500)

PropertyValue
requiredfalse
typeinteger
examples1

last-id

Skip over until the last-id if found

PropertyValue
requiredfalse
typestring
examples05d38fba4098c8531bacfe0da1e0e2ac697f4063

scenario

The scenario of the object that is required. This will filter the clusters relevant to provided scenario.

PropertyValue
requiredtrue
typestring
examplescrm

version

A semver description of the version of the API the client wants to use.
Generally a client should only request a major version.
Either this queryParameter or the header can be used to indicate the version. This parameter takes precedence over the accept-version header.

PropertyValue
requiredtrue
typestring
examples~1.2.0

Possible Responses

200

204

The request was successful, but there is no more data. The client should not try to reconnect

403

You are not allowed to perform this operation

405

This method cannot be performed on this resource

406

MIME-type or API version not supported

500

An interal server error occurred

502

An error occurred in one of the services backing this API (probably the database)

bulk clusters get

CURL EXAMPLE

curl -X GET "https://consumer-api.toyota-europe.com/nmscCodes/{nmscCode}/clusters?limit=1&last-id=05d38fba4098c8531bacfe0da1e0e2ac697f4063&scenario=crm&version=~1.2.0" \
	-H "Accept-Version: ~1.2.0" \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg"

REQUEST HEADERS

Accept-Version: ~1.2.0
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyIsImtpZCI6Im5PbzNaRHJPRFhFSzFqS1doWHNsSFJfS1hFZyJ9.eyJhdWQiOiJhcGk6Ly8xNzIyZGE4Mi0yYjliLTQ4M2UtYTYyZC1jNjJmOWU0ODQzNWUiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC80MWNiNTQ3OC0xZjhhLTRhOGUtYTJiNy01OGJiYzExOThjNTIvIiwiaWF0IjoxNjI0ODcwOTU4LCJuYmYiOjE2MjQ4NzA5NTgsImV4cCI6MTYyNDg3NDg1OCwiYWlvIjoiRTJaZ1lKaFRiWjNGci9PcGZNS0M1Ry9IWmp3MkJ3QT0iLCJhcHBpZCI6IjE3MjJkYTgyLTJiOWItNDgzZS1hNjJkLWM2MmY5ZTQ4NDM1ZSIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0LzQxY2I1NDc4LTFmOGEtNGE4ZS1hMmI3LTU4YmJjMTE5OGM1Mi8iLCJvaWQiOiJmMWMxYTVmMS1iOTRlLTQ0YWUtODc3ZS1jYTJkMmZkYzU1M2IiLCJyaCI6IjAuQVRrQWVGVExRWW9mamtxaXQxaTd3Um1NVW9MYUloZWJLejVJcGkzR0w1NUlRMTQ1QUFBLiIsInJvbGVzIjpbIlRNRS1Db25zdW1lci1Eb21haW4iXSwic3ViIjoiZjFjMWE1ZjEtYjk0ZS00NGFlLTg3N2UtY2EyZDJmZGM1NTNiIiwidGlkIjoiNDFjYjU0NzgtMWY4YS00YThlLWEyYjctNThiYmMxMTk4YzUyIiwidXRpIjoiUmZPMk93cjhKMG1ZZTdYUWRhQnVBQSIsInZlciI6IjEuMCJ9.hJ6yV-NhmBL58g26wEGR53KaqM3FEcec2hRFZeY9qii1qhhGxMbyS_6vr3Ldd1WLHdvzsBECnvo7ArDnEiWsjuU9pC_NM7OL59YxIGy4_Gw2OVdH-9f2VzasNSSqaV6NNh-B14q9liAScLzVObBO_XHnug0qtjGfawEdiPXlbDlgdxfsxBqC45lgMlcRE6RPFOJeNUAvaV4cDgrEdQ0CAmj3Tx2D1JBxBSlYSWXxXwj4vrrRY-zYlpOFqH2GET5S0mCzZvX-_x0GWfB9w6VNxaHDDUHzU-u1Fw7y45JnZE016jX5gdf17j2mEgUDNq-47yXz923OpKygtt16JUFEJg

RESPONSE BODY

Example
{
    "data": [
        {
            "id": "2018-04-18T13:10:28.888Z000012aac9d83a987962aeb1350f930e2986d44b",
            "meta": {
              "createdTimestamp": "2019-04-17T09:29:42.793Z",
              "lastModifiedTimestamp": "2019-04-17T09:29:42.793Z"
            },
            "records": [
                {
                    "sourceName": "crm",
                    "sourceId": "5552312"
                },
                {
                    "sourceName": "crm",
                    "sourceId": "6737366"
                }
            ],
            "nmscCode": "tgb"
        },
        {
            "id": "2018-04-18T13:10:28.888Z0000187f29b6fa3208efb816b6bf12f4262ef83b",
            "meta": {
                "createdTimestamp": "2019-04-17T09:29:42.793Z",
                "lastModifiedTimestamp": "2019-04-17T09:29:42.793Z"
            },
            "records": [
                {
                    "sourceName": "crm",
                    "sourceId": "6738888"
                },
                {
                    "sourceName": "crm",
                    "sourceId": "6738777"
                }
            ],
            "nmscCode": "tgb"
        }
    ],
    "links": {
        "first": "http://consumer-api.toyota-europe.com/nmscCodes/tgb/clusters/?scenario=crm&limit=10",
        "self": "http://consumer-api.toyota-europe.com/nmscCodes/tgb/clusters/?scenario=crm&limit=10",
        "next": "http://consumer-api.toyota-europe.com/nmscCodes/tgb/clusters/?scenario=crm&limit=10&last-id=2018-04-18T13:10:28.888Z00005e31a4ef98976719aaee057c77c36e70b7f7"
    }
}
Type
Jsonapi
Example
id: 2018-04-18T13:10:28.888Z000012aac9d83a987962aeb1350f930e2986d44b
event: record
data: {
            "id": "2018-04-18T13:10:28.888Z000012aac9d83a987962aeb1350f930e2986d44b",
            "meta": {
                "createdTimestamp": "2018-04-18T13:10:28.888Z",
                "lastModifiedTimestamp": "2018-04-18T13:10:28.888Z"
            },
            "records": [
                {
                    "sourceName": "crm",
                    "sourceId": "5552312"
                },
                {
                    "sourceName": "crm",
                    "sourceId": "6737366"
                }
            ],
            "nmscCode": "tgb"
        }

Type: any

RESPONSE BODY

jsonsse