Traversal create
Below is the full body packet expected by the POST /api/v1/{tenantId}/Traversals
endpoint.
{
"shortCode": "string",
"language": "string",
"release": "string",
"algoId": int?,
"nodeId": int?,
"memberReference": "string",
"injectedHistory": InjectedHistory?
}
Definitions
ShortCode
: Product short code. A Product being an algorithm or a set of algorithms. Required
.
Language
: Language of the content, e.g. EN, Dutch. This is nullable and only needs to be filled out if you wish to start a product in a language that isn't the set default. Nullable
.
AlgoId
: A unique identifier given to an algorithm. This should only be used by experts, and is used to start a product at any point. Nullable
.
NodeId
: A unique identifier given to a specific node in an algorithm. This should only be used by experts, and is used to start a product at any point. Nullable
.
MemberReference
: A string reference for patient/members of a system. It is unique per client. This should be used to link traversals together. Without it, the assessment will be anonymous. Nullable
.
InjectedHistory
: A list of data points you wish to insert into the assessment so that questions can be pre-answered/skipped. See InjectedHistory for more details. Nullable
.