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	Type	Description
id	string, core	(Read-only) The identifier for the enrollment.
href	string, core	(Read-only) Represents the enrollment in the API.
certificate	object, core	Represents the certificate object for this enrollment. Example: { "id": "PRG-1234-5678", "href": "/program/programs/PRG-1234-5678", "name": "Microsoft AI Cloud Partner" }
program	object, core	Represents 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, core	Defines the scope of the enrollment. Allowed values are buyer or licensee.
type	string, core	Defines whether the enrollment is new (first time requesting a certificate) or a change (re-enrollment). Allowed values are change or new.
buyer	object, core	(Optional) Represents 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, core	(Optional) Represents 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, core	The eligibility object containing the configuration of the partner program. Example: { "client": true, "partner": false }
status	enum	The enrollment status. Allowed values are: Processing Failed Completed Querying
statusNotes	object	(Optional) Notes added during a status change by the vendor or extensions, indicating the reason for enrollment failure or status change. Example: { "id": "E001234", "message": "Educational certification failed" }
notes	string	(Optional) 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.
error	object	(Optional) The standard error object, indicating that an error occurred during parameter validation. May include markup. Example: { "id": "E001234", "message": "Enrollment has invalid parameters" }
assignee	object	(Optional) 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	(Optional) Represents the enrollmentParameter object, which 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	(Optional) Represents the enrollmentParameter object, which 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	object	(Optional) Represents the template object. Example: { "id": "PTP-1234-4444", "href": "/programs/PRG-1234-1234/templates/TPP-1234-4444", "name": "Successful Activation" }
audit	object	(Read-only) Represents the audit object.

Eligibility object

This object contains the following attributes:

Name	Type	Description
client	boolean	Indicates direct client.
partner	boolean	Indicates indirect client or partner.

Enrollment Parameter object

This object contains the following attributes:

Name	Type	Description
id	string	The primary identifier for the parameter.
name	string	The display name of the parameter.
externalId	string	The ID of the parameter in the external system.
value	string	The parameter value, which can be updated. { "addressLine1": "23 Oakley wood", "city": "Cork", "state": "Cork", "postalCode": "V23U58N" }
displayValue	string	The parameter value (read only).
constraints	object	Represents constraints. When specified, it represents overridden parameter constraints. When unspecified, the parameter constraints must be taken from the parameter definition.
error	object	Represents the error message object.

Examples

ENROLLMENT OBJECT

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