Skip to content

Provision Machines

Provisions the specified machine into the default site of the specified organization. Typically the machine associated with the specified PROSE must present a Call-In-Code before this route will function. In rare cases, VendNovation may enable the ability to provision machines that have not yet presented a Call-In-Code. This ability, if enabled, has a daily rate limit, with the quota resetting at midnight UTC.

Verb POST
Endpoint {base-url}/machines/provision
Max Page Size N/A

Request Body

{
  "requestFilter": {
    // Note that you MUST specify one and only one org id and machine identifier. 
    "organizationIds": [2], 
    "machineIdentifiers": ["PROSE1234567890"]
  }
}

Filters Honored

Returns

On Success

Response Body

// 204 - No content

On Error

HTTP Code Error Code Definition
403 DATA_ACCESS_VIOLATION You do not have access to the specified organization.
422 DATA_VALIDATION_ERROR Exactly one organizationId must be specified.
422 DATA_VALIDATION_ERROR Exactly one machineIdentifier must be specified.
422 MISSING_REQUIRED_DATA The specified machine identifier is not a valid PROSE. Must match PROSE followed by exactly 10 digits.
422 DATA_VALIDATION_ERROR The specified PROSE must end in 0 or 5.
422 DATA_VALIDATION_ERROR The machine has already been provisioned.
400 DEFAULT_SITE The specified organization does not have a default site configured.
400 ORG_PERMISSIONS The specified organization is not enabled for advanced provisioning.
400 LIMIT_EXCEEDED The organization has met or exceeded its daily advanced provisioning limit.