Enrollment

Enrollment is a process through which a client formally registers or signs up to participate in a vendor program.

Once the client fulfills all the necessary conditions, they are considered enrolled in the program, and a certificate is issued.

This object contains the following attributes:

Field Name	Data Type	Description
id	string	The identifier for the enrollment. Example: ENR-1234-1234
href	string	A reference to enrollment in the API. Example: /v1/catalog/enrollments/PRD-1234-1234
certificate	object	A reference to the certificate object for this enrollment. Example: { "id": "PRG-1234-5678", "href": "/program/programs/PRG-1234-5678", "name": "Microsoft AI Cloud Partner" }
program	object	A reference to the program object that the partner enrolls in. Example: { "id": "PRG-1234-1234", "href": "v1/catalog/programs/PRG-1234-5678", "name": "Microsoft AI Cloud Partner", "icon": "/static/PRG-1234-1234/logo.png", "applicableTo": "Buyer" }
applicableTo	string	Defines the scope of the enrollment. Allowed values: buyer or licensee.
type	string	Defines whether the enrollment is new (first time requesting a certificate) or a change (re-enrollment). Allowed values: change or new.
buyer	object	A reference to the buyer object, if the enrollment applies to a buyer. Example: { "id": "PRG-1234-1234", "href": "v1/catalog/programs/PRG-1234-5678", "name": "Microsoft AI Cloud Partner", "icon": "/static/PRG-1234-1234/logo.png", "applicableTo": "Buyer" }
licensee	object	A reference to the licensee object, if the enrollment applies to a licensee. Example: { "id": "CER-1234-1234", "href": "v1/accounts/licensees/LIC-1234-1234-1234" "name": "Stark Industries Limited", "externalId": "WW-CON-12345678" }
eligibility	object (eligibility)	The configuration of the partner program. Example: { "client": true, "partner": false }
status	enum	The status of the enrollment. Allowed values: processing, failed, completed, or querying.
statusNotes	message	Notes added during status change by vendor or vendor extensions to indicate the reason for enrollment failure or status change. Example: { "id": "E001234", "message": "Educational certification failed" }
notes	string	Contains initial customer notes added by the Buyer during the enrollment process. Buyers can edit and add notes at any time for all order statuses. Example: Enroll in a program to purchase the XYZ product.
error	message	The standard error object. It indicates that an error appeared during parameter validation, which can include markup. Example: { "id": "E001234", "message": "Enrollment has invalid parameters" }
assignee	user	The enrollment assignee, set by the vendor. The account must belong to the vendor account. Example: { "id": "USR-3773-5838", "href": "/accounts/ACC-0774-6909/users/USR-3773-5838", "name": "Jack Doe", }
parameters.fulfillment	object (enrollmentParameter)	An object that holds a concise definition of a parameter, its value, and any associated errors. Example: [ { "id": "PRM-1234-1234-1234", "name": "Tennant Id", "externalId": "tenant_id", "constraints": { "readonly": false, "hidden": true, "required": true, "unique": false }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", "error": { "id": "E001234", "message": "Incorrect parameter value" } } ]
parameters.ordering	object (enrollmentParameter)	An object that holds a concise definition of a parameter, its value, and any associated errors. Example: [ { "id": "PRM-1234-1234-1234", "name": "Microsoft Partner Number", "externalId": "partner_id", "constraints": { "readonly": false, "hidden": true, "required": true, "unique": false }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", "error": { "id": "E001234", "message": "Incorrect parameter value" } } ]
template	template	Example: { "id": "PTP-1234-4444", "href": "/programs/PRG-1234-1234/templates/TPP-1234-4444", "name": "Succesful Activation" }
audit	object	A reference to the audit object.

Eligibility object

This object contains the following attributes:

Field Name	Data Type	Description
client	boolean	Indicates direct client. Example: true
partner	boolean	Indicates indirect client (partner). Example: false

EnrollmentParameter object

This object contains the following attributes:

Field Name	Data Type	Description
id	string	The primary identifier for the parameter. Example: PAR-5542-1187-3130
name	string	The display name of the parameter. Example: Tenant ID
externalId	string	The ID of the parameter in the external system. Example: tenant_id
value	string	The parameter value, which can be updated. Example: 69b73824-ce76-4866-ad47-b615ae9d8998 OR { "addressLine1": "23 Oakley wood", "city": "Cork", "state": "Cork", "postalCode": "V23U58N" }
displayValue	string	The parameter value (read only). Example: 69b73824-ce76-4866-ad47-b615ae9d8998 OR 23 Oakley Wood, London.
constraints	parameterConstraints	Parameter constraints. When specified, it represents overridden parameter constraints. When unspecified, the parameter constraints must be taken from the parameter definition. Example: { "readonly": false, "hidden": true, "required": true }
error	object (message)	The standard error object. Example: { "id": "E001234", "message": "Enrollment has invalid parameters" }

Example response

ENROLLMENT OBJECT

{
  "id": "ENR-1234-1234",
  "href": "/v1/products/PRD-1234-1234",
  "certificate": {
    "id": "CER-1234-1234",
    "href": "v1/catalog/certificates/CER-1234-1234"
  },
  "program": {
    "id": "PRG-1234-1234",
    "href": "v1/catalog/programs/PRG-1234-5678",
    "name": "Microsoft AI Cloud Partner",
    "icon": "/static/PRG-1234-1234/logo.png",
    "applicableTo": "Buyer"
  },
  "applicableTo": "Buyer",
  "buyer": {
    "id": "BUY-1234-1234",
    "href": "v1/accounts/buyers/BUY-1234-1234",
    "name": "MPN EU"
  },
  "eligibility": {
    "client": true,
    "partner": true
  },
  "status": "Processing",
  "notes": "draft enrollment for review",
  "assignee": "",
  "parameters.fulfillment": [
  {
      "id": "PRM-1234-1234-1234",
      "name": "Tennant Id",
      "externalId": "tenant_id",
      "constraints": {
          "readonly": false,
          "hidden": true,
          "required": true,
          "unique": false
      },
      "value": "69b73824-ce76-4866-ad47-b615ae9d8998",
      "error": {
          "id": "E001234",
          "message": "Incorrect parameter value"
      }
  }],
  "parameters.ordering": []
}
    

ENROLLMENT PARAMETER OBJECT