LabTest

Lab Test Serializer

Entity Type Constraint: Only one entity type (items, materials, or styles) should be provided per request.

oneOf

• Item
• Material
• Style

clientIdstringnullable

Possible values: <= 255 characters

applicantIdstringnullable

Possible values: <= 255 characters

testTypestringrequired

Possible values: <= 255 characters

testFormstringrequired

Possible values: <= 255 characters

purchaseOrdersstring[]nullable

Possible values: <= 255 characters

testServicesstring[]nullable

expectedCompletionDatestring<date>nullable

productionDatestring<date>nullable

billingInformation objectnullable

localOrganizationIdstringnullable

Possible values: <= 255 characters

namestringnullable

Possible values: <= 255 characters

Default value:

addressstringnullable

Possible values: <= 255 characters

Default value:

citystringnullable

Possible values: <= 255 characters

Default value:

countrystringnullable

Possible values: <= 255 characters

Default value:

postalstringnullable

Possible values: <= 255 characters

Default value:

provincestringnullable

Possible values: <= 255 characters

Default value:

contacts object[]nullable

Array [

namestringnullable

Possible values: <= 255 characters

Default value:

emailstringnullable

Possible values: <= 255 characters

Default value:

telephoneNumberstringnullable

Possible values: <= 80 characters

Default value:

mobileNumberstringnullable

Possible values: <= 80 characters

Default value:

]

tierintegernullable

Possible values: >= 1 and <= 3

labTestAgency objectnullable

localOrganizationIdstringnullable

Possible values: <= 255 characters

namestringnullable

Possible values: <= 255 characters

Default value:

addressstringnullable

Possible values: <= 255 characters

Default value:

citystringnullable

Possible values: <= 255 characters

Default value:

countrystringnullable

Possible values: <= 255 characters

Default value:

postalstringnullable

Possible values: <= 255 characters

Default value:

provincestringnullable

Possible values: <= 255 characters

Default value:

contacts object[]nullable

Array [

namestringnullable

Possible values: <= 255 characters

Default value:

emailstringnullable

Possible values: <= 255 characters

Default value:

telephoneNumberstringnullable

Possible values: <= 80 characters

Default value:

mobileNumberstringnullable

Possible values: <= 80 characters

Default value:

]

tierintegernullable

Possible values: >= 1 and <= 3

retailerBrand objectnullable

localOrganizationIdstringnullable

Possible values: <= 255 characters

namestringnullable

Possible values: <= 255 characters

Default value:

addressstringnullable

Possible values: <= 255 characters

Default value:

citystringnullable

Possible values: <= 255 characters

Default value:

countrystringnullable

Possible values: <= 255 characters

Default value:

postalstringnullable

Possible values: <= 255 characters

Default value:

provincestringnullable

Possible values: <= 255 characters

Default value:

contacts object[]nullable

Array [

namestringnullable

Possible values: <= 255 characters

Default value:

emailstringnullable

Possible values: <= 255 characters

Default value:

telephoneNumberstringnullable

Possible values: <= 80 characters

Default value:

mobileNumberstringnullable

Possible values: <= 80 characters

Default value:

]

tierintegernullable

Possible values: >= 1 and <= 3

factories object[]nullable

Array [

localOrganizationIdstringnullable

Possible values: <= 255 characters

namestringnullable

Possible values: <= 255 characters

Default value:

addressstringnullable

Possible values: <= 255 characters

Default value:

citystringnullable

Possible values: <= 255 characters

Default value:

countrystringnullable

Possible values: <= 255 characters

Default value:

postalstringnullable

Possible values: <= 255 characters

Default value:

provincestringnullable

Possible values: <= 255 characters

Default value:

contacts object[]nullable

Array [

namestringnullable

Possible values: <= 255 characters

Default value:

emailstringnullable

Possible values: <= 255 characters

Default value:

telephoneNumberstringnullable

Possible values: <= 80 characters

Default value:

mobileNumberstringnullable

Possible values: <= 80 characters

Default value:

]

tierintegernullable

Possible values: >= 1 and <= 3

]

suppliers object[]nullable

Array [

localOrganizationIdstringnullable

Possible values: <= 255 characters

namestringnullable

Possible values: <= 255 characters

Default value:

addressstringnullable

Possible values: <= 255 characters

Default value:

citystringnullable

Possible values: <= 255 characters

Default value:

countrystringnullable

Possible values: <= 255 characters

Default value:

postalstringnullable

Possible values: <= 255 characters

Default value:

provincestringnullable

Possible values: <= 255 characters

Default value:

contacts object[]nullable

Array [

namestringnullable

Possible values: <= 255 characters

Default value:

emailstringnullable

Possible values: <= 255 characters

Default value:

telephoneNumberstringnullable

Possible values: <= 80 characters

Default value:

mobileNumberstringnullable

Possible values: <= 80 characters

Default value:

]

tierintegernullable

Possible values: >= 1 and <= 3

]

remarksstring[]nullable

Possible values: <= 255 characters

stageOfTestingstring[]nullable

Possible values: <= 255 characters

items object[]required

Array of items for the lab test

Array [

itemIdstringrequired

Possible values: <= 255 characters

itemNamestringnullable

Possible values: <= 255 characters

itemDescriptionstringnullable

Possible values: <= 255 characters

styleIdstringrequired

Possible values: <= 255 characters

styleNamestringnullable

Possible values: <= 255 characters

colorstringnullable

Possible values: <= 255 characters

Default value:

sizestringnullable

Possible values: <= 255 characters

originCountrystring[]nullable

Possible values: Value must match regular expression ^[A-Z]{2}$

sampleSizeintegernullable

Sample size. Used only when samples is omitted and the Product has no stored samples; otherwise it is derived from the sample count.

unitstringnullable

Possible values: <= 255 characters

samples object[]

Samples of this Product, each with its own details. Required when the Lab Test Form includes the Sample Information component.

Send the complete list, not a patch. Samples are matched by sampleName, and any stored sample missing from the list is deleted. sampleSize then becomes the sample count and unit the samples' shared unit, overriding both sent on the Product.

sampleName must be unique within the Product, and all samples must share one unit.

Array [

sampleNamestringrequired

Sample name. Must not be blank (surrounding whitespace is trimmed) and must be unique within the Product.

Possible values: <= 255 characters

Example: Lot A

lotBatchNumberstring

Lot / batch number

Possible values: <= 255 characters

Example: LB-2026-001

colorstring

Color

Possible values: <= 255 characters

Example: Navy

sampleAmountnumbernullable

Sample amount

Possible values: >= 0

Example: 2

unitstring

Unit of the sample amount. All samples of a Product must share the same unit.

Possible values: <= 255 characters

Example: pcs

sampleDescriptionstring

Sample description

Example: Front panel swatch

]

]

sampleReceiptDatestring<date>nullable

Date when sample was received (required for creating a completed lab test)

reportIssueDatestring<date>nullable

Date when report was issued (required for creating a completed lab test)

reportNumberstringnullable

Report number (required for creating a completed lab test)

originalReportNumberstringnullable

Original report number (required for creating a completed lab test)

revisionNumberintegernullable

Revision number (required for creating a completed lab test)

Possible values: >= 0

Default value: 0

testPackages object[]nullable

Test packages

Array [

idstringrequired

Possible values: <= 255 characters

namestringnullable

Possible values: <= 255 characters

Default value:

]

testProperties object[]nullable

Test properties (required for creating a completed lab test)

Array [

oneOf

• Item
• Material
• Style

idstringrequired

namestringrequired

testPackageIdstringnullable

testCategoryIdstringnullable

testSubcategoryIdstringnullable

testMethodstringnullable

resultstringnullable

Possible values: [pass, fail, data, na]

reviewResultstringnullable

Possible values: <= 255 characters

items object[]nullable

Array [

itemIdstringnullable

testConditions object[]nullable

Array [

idstringnullable

namestringnullable

resultResultEnumnullable

Possible values: [pass, fail, data, na]

samples object[]nullable

Test condition readings and the samples each one applies to.

Send only one of these two fields, never both:

• sampleNames when the Lab Test Form includes the Sample Information component.
• sampleNumbers when it does not.

Array [

datastringnullable

The reading recorded for these samples.

Example: Grade 4-5

resultstringrequired

The outcome recorded for these samples.

Possible values: [pass, fail, data]

Example: pass

sampleNumbersinteger[]

Samples identified by position in the Product's sample list, counting from 1. A number greater than the Product's sample size is rejected.

Example: [1,2]

sampleNamesstring[]

Samples identified by their sampleName on the Product. Each name must match one of the Product's samples: names are checked against the samples sent in the same request when the request carries the Product, and against the Product's stored samples otherwise.

Example: ["Lot A","Lot B"]

]

followUpAction objectnullable

commentstringnullable

attachments object[]nullable

Array [

fileIdstring<uuid>required

labelstringnullable

]

failureCategoryIdstringnullable

failureCategoryNamestringnullable

failureIdstringnullable

failureNamestringnullable

failureSeveritystringnullable

Possible values: [critical, major, minor]

]

]

]

overallResult objectnullable

Overall test result (required for creating a completed lab test)

resultResultEnumrequired

Possible values: [pass, fail, data, na]

reviewResultstringnullable

Possible values: <= 255 characters

attachments object[]nullable

Attached files for Test Report (type "testReport") or General Lab Test Information (type "others").

Array [

fileIdstringrequired

Possible values: <= 64 characters

typeTypeEnumrequired

Possible values: [testReport, others]

labelstringnullable

Possible values: <= 255 characters

Default value:

]

LabTest

{
  "clientId": "string",
  "applicantId": "string",
  "testType": "string",
  "testForm": "string",
  "purchaseOrders": [
    "string"
  ],
  "testServices": [
    "string"
  ],
  "expectedCompletionDate": "2024-07-29",
  "productionDate": "2024-07-29",
  "billingInformation": {
    "localOrganizationId": "string",
    "name": "",
    "address": "",
    "city": "",
    "country": "",
    "postal": "",
    "province": "",
    "contacts": [
      {
        "name": "",
        "email": "",
        "telephoneNumber": "",
        "mobileNumber": ""
      }
    ],
    "tier": 0
  },
  "labTestAgency": {
    "localOrganizationId": "string",
    "name": "",
    "address": "",
    "city": "",
    "country": "",
    "postal": "",
    "province": "",
    "contacts": [
      {
        "name": "",
        "email": "",
        "telephoneNumber": "",
        "mobileNumber": ""
      }
    ],
    "tier": 0
  },
  "retailerBrand": {
    "localOrganizationId": "string",
    "name": "",
    "address": "",
    "city": "",
    "country": "",
    "postal": "",
    "province": "",
    "contacts": [
      {
        "name": "",
        "email": "",
        "telephoneNumber": "",
        "mobileNumber": ""
      }
    ],
    "tier": 0
  },
  "factories": [
    {
      "localOrganizationId": "string",
      "name": "",
      "address": "",
      "city": "",
      "country": "",
      "postal": "",
      "province": "",
      "contacts": [
        {
          "name": "",
          "email": "",
          "telephoneNumber": "",
          "mobileNumber": ""
        }
      ],
      "tier": 0
    }
  ],
  "suppliers": [
    {
      "localOrganizationId": "string",
      "name": "",
      "address": "",
      "city": "",
      "country": "",
      "postal": "",
      "province": "",
      "contacts": [
        {
          "name": "",
          "email": "",
          "telephoneNumber": "",
          "mobileNumber": ""
        }
      ],
      "tier": 0
    }
  ],
  "remarks": [
    "string"
  ],
  "stageOfTesting": [
    "string"
  ],
  "items": [
    {
      "itemId": "string",
      "itemName": "string",
      "itemDescription": "string",
      "styleId": "string",
      "styleName": "string",
      "color": "",
      "size": "string",
      "originCountry": [
        "string"
      ],
      "sampleSize": 0,
      "unit": "string",
      "samples": [
        {
          "sampleName": "Lot A",
          "lotBatchNumber": "LB-2026-001",
          "color": "Navy",
          "sampleAmount": 2,
          "unit": "pcs",
          "sampleDescription": "Front panel swatch"
        }
      ]
    }
  ],
  "sampleReceiptDate": "2024-07-29",
  "reportIssueDate": "2024-07-29",
  "reportNumber": "string",
  "originalReportNumber": "string",
  "revisionNumber": 0,
  "testPackages": [
    {
      "id": "string",
      "name": ""
    }
  ],
  "testProperties": [
    {
      "id": "string",
      "name": "string",
      "testPackageId": "string",
      "testCategoryId": "string",
      "testSubcategoryId": "string",
      "testMethod": "string",
      "result": "pass",
      "reviewResult": "string",
      "items": [
        {
          "itemId": "string",
          "testConditions": [
            {
              "id": "string",
              "name": "string",
              "result": "pass",
              "samples": [
                {
                  "data": "Grade 4-5",
                  "result": "pass",
                  "sampleNumbers": [
                    1,
                    2
                  ],
                  "sampleNames": [
                    "Lot A",
                    "Lot B"
                  ]
                }
              ],
              "followUpAction": {
                "comment": "string",
                "attachments": [
                  {
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "label": "string"
                  }
                ],
                "failureCategoryId": "string",
                "failureCategoryName": "string",
                "failureId": "string",
                "failureName": "string",
                "failureSeverity": "critical"
              }
            }
          ]
        }
      ]
    },
    {
      "id": "string",
      "name": "string",
      "testPackageId": "string",
      "testCategoryId": "string",
      "testSubcategoryId": "string",
      "testMethod": "string",
      "result": "pass",
      "reviewResult": "string",
      "materials": [
        {
          "materialId": "string",
          "testConditions": [
            {
              "id": "string",
              "name": "string",
              "result": "pass",
              "samples": [
                {
                  "data": "Grade 4-5",
                  "result": "pass",
                  "sampleNumbers": [
                    1,
                    2
                  ],
                  "sampleNames": [
                    "Lot A",
                    "Lot B"
                  ]
                }
              ],
              "followUpAction": {
                "comment": "string",
                "attachments": [
                  {
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "label": "string"
                  }
                ],
                "failureCategoryId": "string",
                "failureCategoryName": "string",
                "failureId": "string",
                "failureName": "string",
                "failureSeverity": "critical"
              }
            }
          ]
        }
      ]
    },
    {
      "id": "string",
      "name": "string",
      "testPackageId": "string",
      "testCategoryId": "string",
      "testSubcategoryId": "string",
      "testMethod": "string",
      "result": "pass",
      "reviewResult": "string",
      "styles": [
        {
          "styleId": "string",
          "testConditions": [
            {
              "id": "string",
              "name": "string",
              "result": "pass",
              "samples": [
                {
                  "data": "Grade 4-5",
                  "result": "pass",
                  "sampleNumbers": [
                    1,
                    2
                  ],
                  "sampleNames": [
                    "Lot A",
                    "Lot B"
                  ]
                }
              ],
              "followUpAction": {
                "comment": "string",
                "attachments": [
                  {
                    "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "label": "string"
                  }
                ],
                "failureCategoryId": "string",
                "failureCategoryName": "string",
                "failureId": "string",
                "failureName": "string",
                "failureSeverity": "critical"
              }
            }
          ]
        }
      ]
    }
  ],
  "overallResult": {
    "result": "pass",
    "reviewResult": "string"
  },
  "attachments": [
    {
      "fileId": "string",
      "type": "testReport",
      "label": ""
    }
  ]
}