Page Comparison

Versions Compared

Old Version 1

changes.mady.by.user David Hunt (Unlicensed)

Saved on Jun 25, 2019

compared with

New Version Current

changes.mady.by.user David Hunt (Unlicensed)

Saved on Dec 20, 2023

Key

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

Overview

<the user

Info

title	Required Headers

Key	Value	Example
User-Agent	<company identifier>	The exact value here is not important, but it should include something to identify your company
Accept	application/json
Authorization	Bearer <your token>	Bearer wV1MLk5+sFzioJw/3M5r9A==
Content-Type	application/json
X-

Assessment

LearnerId

<the

assessment>

vbm

X-UserId

learner id>

The DMTD-supplied identifier that identifies the

owner of the purchase (see Getting started

learner (see REST API Guide and /1/learner - POST)

X-

UserCode

LearnerCode

<the

user

learner code>

A REST-client-supplied identifier that identifies the

owner of the purchase (see Getting started

learner (see REST API Guide and /1/learner - POST)

Info

title	Fields

Field	Type	Optional	Description
systemDomain	String	Required	The DMTD-Supported domain of the purchase ('vbmapp', 'efl')

type

productType	String	Required	The type of product being purchased in the SystemDomain ('assessment', 'training')
locale	String	Required	The locale (language) of the assessment ('en', 'es', 'fr')
trainingProduct	String	Optional	Type type of training product being purchased ('conducting'). Required when type == 'training'

Info

title	Locale

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

Example

Info

title	Example

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

Info

title	Response

{
    "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"
    }
}