Mix Consumption API (v1)

Download OpenAPI specification:Download

An API that can receive details about components that are consumed while doing a mix

Changelog

All notable changes to this project will be documented in this file.

[1.2.0] - 2024-02-15

  • Renamed authorization header from X-Subscription-Key to AccessKey
  • Changed HTTP Method of /v1/partial-mix from PATCH to POST

[1.1.0] - 2024-02-15

  • Made mixRepairOrderDetails optional in InitialMix
  • Added mixUpdateTime to PartialMix

[1.0.0] - 2024-01-11

  • Initial release

Initial mix consumption information

Initial mix information

Authorizations:
ApiKeyAuthorization
Request Body schema: application/json
required

Information about the mix consumption

mixId
required
string <uuid> <= 36 characters

An id which uniquely identifies a mix

mixDescription
string or null <= 120 characters

A description of the mix

mixDateTime
required
string <date-time>

Represents the date and time when the mix was started. It is expressed in UTC with a time zone offset.

mixNumber
required
string [ 1 .. 255 ] characters

The number associated with the mix

mixedByUser
required
string [ 1 .. 255 ] characters

Name of the user that created the mix

shopId
required
string <uuid> <= 36 characters

An id which uniquely identifies the shop that poured the mix

Array of objects (MixRepairOrderDetails)

The repair order details associated with the mix

required
Array of objects (MixComponent)

Components of the mix

scaleId
required
string <= 36 characters

An id which uniquely identifies a scale

object (MixRoom)
mixState
required
string (MixState)
Enum: "Paused" "Completed" "CompletedWithoutPrimer" "Cancelled" "Incomplete"

Responses

Request samples

Content type
application/json
{
  • "mixId": "4f8b533f-7449-4056-92ff-11b1de94d656",
  • "mixDescription": "SES5M",
  • "mixDateTime": "2018-06-07T12:51:25.077Z",
  • "mixNumber": 131,
  • "mixedByUser": "john.smith@example.com",
  • "shopId": "f6553319-234b-430d-8bc0-3f803c1a8434",
  • "mixRepairOrderDetails": [
    ],
  • "pouredComponents": [
    ],
  • "scaleId": "scale-id",
  • "mixRoom": {
    },
  • "mixState": "Paused"
}

Response samples

Content type
application/json
Example
{}

Update Partial Mix Information

Apply a partial update to an existing mix

Authorizations:
ApiKeyAuthorization
Request Body schema: application/json
required

Mix consumption information to be updated

mixId
required
string <uuid> <= 36 characters

An id which uniquely identifies a mix

scaleId
required
string <= 36 characters

An id which uniquely identifies a scale

Array of objects (MixRepairOrderDetails)

The repair order details associated with the mix

mixUpdateTime
required
string <date-time>

Represents the date and time when the mix was resumed. It is expressed in UTC with a time zone offset.

required
Array of objects (MixComponent)

Components of the mix

object (MixRoom)
mixState
required
string (MixState)
Enum: "Paused" "Completed" "CompletedWithoutPrimer" "Cancelled" "Incomplete"

Responses

Request samples

Content type
application/json
{
  • "mixId": "4f8b533f-7449-4056-92ff-11b1de94d656",
  • "scaleId": "scale-id",
  • "mixRepairOrderDetails": [
    ],
  • "mixUpdateTime": "2018-06-08T14:00:00.000Z",
  • "pouredComponents": [
    ],
  • "mixRoom": {
    },
  • "mixState": "Paused"
}

Response samples

Content type
application/json
Example
{}