Create/Update Lab Test

PUT 
/api/v1/lab-tests

Create/Update Lab Test

Request

application/json

Body

required

clientId stringnullable

Possible values: <= 255 characters

applicantId stringnullable

Possible values: <= 255 characters

testType stringrequired

Possible values: <= 255 characters

testForm stringrequired

Possible values: <= 255 characters

purchaseOrders string[]nullable

Possible values: <= 255 characters

labTestAgency

object

nullable

localOrganizationId stringnullable

Possible values: <= 255 characters

name stringnullable

Possible values: <= 255 characters

address stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

country stringnullable

Possible values: <= 255 characters

postal stringnullable

Possible values: <= 255 characters

province stringnullable

Possible values: <= 255 characters

contacts

object[]

nullable

Array [

name stringnullable

Possible values: <= 255 characters

email stringnullable

Possible values: <= 255 characters

telephoneNumber stringnullable

Possible values: <= 80 characters

mobileNumber stringnullable

Possible values: <= 80 characters

]

tier integernullable

Possible values: >= 1 and <= 3

retailerBrand

object

nullable

localOrganizationId stringnullable

Possible values: <= 255 characters

name stringnullable

Possible values: <= 255 characters

address stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

country stringnullable

Possible values: <= 255 characters

postal stringnullable

Possible values: <= 255 characters

province stringnullable

Possible values: <= 255 characters

contacts

object[]

nullable

Array [

name stringnullable

Possible values: <= 255 characters

email stringnullable

Possible values: <= 255 characters

telephoneNumber stringnullable

Possible values: <= 80 characters

mobileNumber stringnullable

Possible values: <= 80 characters

]

tier integernullable

Possible values: >= 1 and <= 3

factories

object[]

nullable

Array [

localOrganizationId stringnullable

Possible values: <= 255 characters

name stringnullable

Possible values: <= 255 characters

address stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

country stringnullable

Possible values: <= 255 characters

postal stringnullable

Possible values: <= 255 characters

province stringnullable

Possible values: <= 255 characters

contacts

object[]

nullable

Array [

name stringnullable

Possible values: <= 255 characters

email stringnullable

Possible values: <= 255 characters

telephoneNumber stringnullable

Possible values: <= 80 characters

mobileNumber stringnullable

Possible values: <= 80 characters

]

tier integernullable

Possible values: >= 1 and <= 3

]

suppliers

object[]

nullable

Array [

localOrganizationId stringnullable

Possible values: <= 255 characters

name stringnullable

Possible values: <= 255 characters

address stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

country stringnullable

Possible values: <= 255 characters

postal stringnullable

Possible values: <= 255 characters

province stringnullable

Possible values: <= 255 characters

contacts

object[]

nullable

Array [

name stringnullable

Possible values: <= 255 characters

email stringnullable

Possible values: <= 255 characters

telephoneNumber stringnullable

Possible values: <= 80 characters

mobileNumber stringnullable

Possible values: <= 80 characters

]

tier integernullable

Possible values: >= 1 and <= 3

]

items

object[]

nullable

Array [

itemId stringrequired

Possible values: <= 255 characters

styleId stringrequired

Possible values: <= 255 characters

color stringnullable

Possible values: <= 255 characters

barcode stringnullable

Possible values: <= 255 characters

sampleSize integernullable

unit stringnullable

Possible values: <= 255 characters

]

materials

object[]

nullable

Array [

materialId stringrequired

Possible values: <= 255 characters

providerMaterialID stringnullable

Possible values: <= 255 characters

color stringnullable

Possible values: <= 255 characters

sampleSize integernullable

unit stringnullable

Possible values: <= 255 characters

]

remarks string[]nullable

Possible values: <= 255 characters

stageOfTesting string[]nullable

Possible values: <= 255 characters

sampleReceiptDate daterequired
reportIssueDate daterequired
reportNumber stringrequired
originalReportNumber stringrequired

testPackages

object[]

nullable

Array [

id stringrequired

Possible values: <= 255 characters

name stringnullable

Possible values: <= 255 characters

]

testProperties

object[]

required

Array [

id stringrequired

Possible values: <= 255 characters

name stringrequired

Possible values: <= 255 characters

testPackageId stringnullable

Possible values: <= 255 characters

]

testPropertyResults

object[]

required

Array [

testPropertyId stringrequired

Possible values: <= 255 characters

result ResultEnum (string)required

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

• pass - Pass
• fail - Fail
• data - Data
• na - N/A

]

overallResult

object

required

result ResultEnum (string)required

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

• pass - Pass
• fail - Fail
• data - Data
• na - N/A

attachments

object[]

nullable

Array [

fileId stringrequired

Possible values: <= 64 characters

type TypeEnum (string)required

Possible values: [testReport, others]

• testReport - testReport
• others - others

label stringnullable

Possible values: <= 255 characters

]

Responses

201

Lab Test Created Successfully

application/json

Schema

Schema

caseNumber string

Lab test case number

uuid string

Lab test uuid

code integer

Response status code

status integer

Response status code

Example (from schema)

{
  "caseNumber": "string",
  "uuid": "b04ed17c-0253-40a1-bc3c-5df138643057",
  "code": 201,
  "status": 201
}

204

Lab Test Updated Successfully

application/json

Schema

Schema

caseNumber string

Lab test case number

uuid string

Lab test uuid

code integer

Response status code

status integer

Response status code

Example (from schema)

{
  "caseNumber": "string",
  "uuid": "b04ed17c-0253-40a1-bc3c-5df138643057",
  "code": 204,
  "status": 204
}

400

Bad Request

application/json

Schema

Schema

detail string

Bad request error message

code integer

Response status code

status integer

Response status code

Example (from schema)

{
  "detail": "string",
  "code": 400,
  "status": 400
}

401

Unauthorized

text/plain

Schema

Schema

string

Loading...