Program Terms Variants

The Terms Variant Object represents a terms variant as an uploaded PDF or DOCX document, or a link to an externally hosted document, as an element of the terms for a program.

This object contains the following attributes:

Field	Type	Description
id	string	The business identifier of the terms variant. Example: TCS-0001-0001
href	string	The resource URI of the terms variant. Example: /programs/PRG-1234-1234/terms/TCS-1234-1234-1234/variants/TCV-1234-1234-1234-1234
type	string	Terms Item type. Possible values: Online or File.
name	string	The name of the term's variant. Example: Terms of Service - EN
description	string	The description of the term's variant. Example: Terms of Service in English.
assetUrl	string	The URL of the terms item uploaded document or online document/resource. Example: /programs/PRG-1234-1234/terms/TCS-1234-1234-1234/variants/TCV-1234-1234-1234-1234
languageCode	string	A 2-digit language code from the list of language codes in ISO 639 and its corresponding data format. When the type is Online, ‘null’ will appear as ‘multiple’ in the UI. Example: 100
status	string	The status of the terms variant. Possible values: Draft, Published, Unpublished, or Published.
program	program	The program to which the variant belongs.
audit	audit	The audit information object. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

TERMS VARIANT OBJECT

{
  "id": "TCS-1234-1234-1234-1234",
  "href": "/programs/PRG-1234-1234/terms/TCS-1234-1234-1234/variants/TCV-1234-1234-1234-1234",
  "name": "Terms and Conditions Variant - EN",
  "description": "Terms and Conditions Variant in English",
  "type": "Online",
  "assetUrl": "https://www.microsoft.com",
  "languageCode": "en",
  "state": "Draft",
  "termsAndConditions": {
    "id": "TCS-1234-1234-1234",
    "href": "/programs/PRG-1234-1234/terms/TCS-1234-1234-1234",
    "name": "Microsoft 365 Terms of Service"
  },
  "audit": {
    "created": {
      "at": "2024-01-16T21:30:13.1046031",
      "by": {
        "id": "USR-0000-0001"
      }
    },
    "updated": null
  }
}