Versions Compared

Old Version 5

changes.mady.by.user David Hunt

Saved on

compared with

New Version Current

changes.mady.by.user David Hunt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Info
titleRequired Headers


Key
Value
Example
User-Agent<company identifier>The exact value here is not important, but it should include something to identify your company
Acceptapplication/json
AuthorizationBearer <your token>Bearer wV1MLk5+sFzioJw/3M5r9A==
Content-Typeapplication/json
X-LearnerId<the learner id>The DMTD-supplied identifier that identifies the learner (see Getting startedREST API Guide and /1/learner - POST)
X-LearnerCode<the learner code>A REST-client-supplied identifier that identifies the learner (see Getting startedREST API Guide and /1/learner - POST)



Info
titleFields


FieldTypeOptionalDescription
systemDomainStringRequiredThe DMTD-Supported domain of the purchase ('vbmapp', 'efl')
typeproductTypeStringRequiredThe type of product being purchased in the SystemDomain ('assessment', 'training')
localeStringRequiredThe locale (language) of the assessment ('en', 'es', 'fr')

trainingProduct

StringOptionalType type of training product being purchased ('conducting').  Required when type == 'training'



Info
titleLocale

Please note: The locale that is specified dictates the language the protocol and guide.

Example

Info
titleExample
curl -X POST \
  -H 'User-Agent: dmtd-rest-api' \
  -H 'Authorization: Bearer L2Hth4lRwgHRBWtX8Hkl5w==' \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-LearnerId: 1" \
  -d '{ "systemDomain": "vbmapp", "typeproductType": "assessment", "locale": "en" }' \
  httphttps://dataapi-sandbox.datamtd.com/1/purchase


Info
titleResponse
{
    "quantity": 1,
    "subscriptionLength": {
        "type": "years",
        "length": 1
    },
    "id": 15,
    "purchasedProductsGenerated": true,
    "organizationId": 9,
    "updatedAt": "2019-07-16T14:06:54Z",
    "createdAt": "2019-07-16T14:06:54Z",
    "completed": true,
    "productDescription": {
        "systemDomain": "vbmapp",
        "productType": "assessment"
    }
}