Jump to

• Request
• Response

v3.0

put

/ec-site-svc/rest/v3.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals

Compared with v2, this version adds operationType-driven bulk actions (CREATE, UPDATE, REMOVE) for lab normals.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• studyId(required): string(uuid)
  Study identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyLabId(required): string(uuid)
  The lab ID for which to create lab normals.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object LabNormalOpTypeTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LabNormalOpTypeTO"
    }
}

Nested Schema : LabNormalOpTypeTO

Type: object

Show Source

• labNormalList(required): array Lab Normal List
  Title: Lab Normal List

  Lab normals included in the operation.
• operationType(required): string
  Allowed Values: [ "CREATE", "UPDATE", "REMOVE" ]

  Operation for each lab normal bundle. Allowed values: CREATE (add new lab normal rows), UPDATE (modify existing rows), REMOVE (delete existing rows).

  Example: UPDATE

{
    "required":[
        "labNormalList",
        "operationType"
    ],
    "type":"object",
    "properties":{
        "operationType":{
            "type":"string",
            "description":"Operation for each lab normal bundle. Allowed values: CREATE (add new lab normal rows), UPDATE (modify existing rows), REMOVE (delete existing rows).",
            "example":"UPDATE",
            "enum":[
                "CREATE",
                "UPDATE",
                "REMOVE"
            ]
        },
        "labNormalList":{
            "title":"Lab Normal List",
            "type":"array",
            "description":"Lab normals included in the operation.",
            "example":[
                {
                    "sequence":1,
                    "test":"HEMOGLOBIN",
                    "labUnit":"mg/dL",
                    "lowRange":"10",
                    "highRange":"100",
                    "gender":"Female",
                    "ageFrom":5,
                    "ageTo":15,
                    "ageFromUnits":"years",
                    "ageToUnits":"years"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/LabNormalTO"
            }
        }
    }
}

Nested Schema : Lab Normal List

Type: array

Title: Lab Normal List

Lab normals included in the operation.

Show Source

• Array of: object LabNormalTO v1.0
  Title: LabNormalTO v1.0

  Schema describing a lab normal entry.

{
    "title":"Lab Normal List",
    "type":"array",
    "description":"Lab normals included in the operation.",
    "example":[
        {
            "sequence":1,
            "test":"HEMOGLOBIN",
            "labUnit":"mg/dL",
            "lowRange":"10",
            "highRange":"100",
            "gender":"Female",
            "ageFrom":5,
            "ageTo":15,
            "ageFromUnits":"years",
            "ageToUnits":"years"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LabNormalTO"
    }
}

Example:

[
    {
        "sequence":1,
        "test":"HEMOGLOBIN",
        "labUnit":"mg/dL",
        "lowRange":"10",
        "highRange":"100",
        "gender":"Female",
        "ageFrom":5,
        "ageTo":15,
        "ageFromUnits":"years",
        "ageToUnits":"years"
    }
]

Nested Schema : LabNormalTO v1.0

Type: object

Title: LabNormalTO v1.0

Schema describing a lab normal entry.

Show Source

• ageFrom(required): integer (int32)
  Title: Age From

  Lower bound for the age range.

  Example: 5
• ageFromUnits(required): string
  Title: Age From Units

  Units used for the lower age bound.

  Example: years
• ageTo(required): integer (int32)
  Title: Age To

  Upper bound for the age range.

  Example: 15
• ageToUnits(required): string
  Title: Age To Units

  Units used for the upper age bound.

  Example: years
• effectiveDate(required): string (date)
  Title: Effective Date

  Date when the lab normal becomes effective.

  Example: 2025-01-01
• fasting: string
  Title: Fasting

  Allowed Values: [ "Yes", "No" ]

  Fasting flag for the lab normal.

  Example: Yes
• gender: string
  Title: Gender

  Gender applicable to the lab normal.

  Example: Female
• highRange: string
  Title: High Range

  Upper limit for the lab normal range.

  Example: 100
• labNormalId: string (uuid)
• labUnit: string
  Title: Lab Unit

  Measurement unit for the lab test.

  Example: mg/dL
• lowRange: string
  Title: Low Range

  Lower limit for the lab normal range.

  Example: 10
• race: string
  Title: Race

  Race targeted by the lab normal.

  Example: Asian
• sequence(required): integer (int32)
  Title: Sequence

  Minimum Value: 1

  Ordering number for the lab normal.

  Example: 5
• standardResult: string
  Title: Standard Result

  Standard result value for the lab normal.

  Example: 100
• test(required): string
  Title: Test

  Name of the lab test.

  Example: HEMOGLOBIN

{
    "title":"LabNormalTO v1.0",
    "required":[
        "ageFrom",
        "ageFromUnits",
        "ageTo",
        "ageToUnits",
        "effectiveDate",
        "sequence",
        "test"
    ],
    "type":"object",
    "properties":{
        "labNormalId":{
            "type":"string",
            "format":"uuid"
        },
        "sequence":{
            "title":"Sequence",
            "minimum":1,
            "type":"integer",
            "description":"Ordering number for the lab normal.",
            "format":"int32",
            "example":5
        },
        "test":{
            "title":"Test",
            "type":"string",
            "description":"Name of the lab test.",
            "example":"HEMOGLOBIN"
        },
        "labUnit":{
            "title":"Lab Unit",
            "type":"string",
            "description":"Measurement unit for the lab test.",
            "example":"mg/dL"
        },
        "lowRange":{
            "title":"Low Range",
            "type":"string",
            "description":"Lower limit for the lab normal range.",
            "example":"10"
        },
        "highRange":{
            "title":"High Range",
            "type":"string",
            "description":"Upper limit for the lab normal range.",
            "example":"100"
        },
        "standardResult":{
            "title":"Standard Result",
            "type":"string",
            "description":"Standard result value for the lab normal.",
            "example":"100"
        },
        "gender":{
            "title":"Gender",
            "type":"string",
            "description":"Gender applicable to the lab normal.",
            "example":"Female"
        },
        "ageFrom":{
            "title":"Age From",
            "type":"integer",
            "description":"Lower bound for the age range.",
            "format":"int32",
            "example":5
        },
        "ageTo":{
            "title":"Age To",
            "type":"integer",
            "description":"Upper bound for the age range.",
            "format":"int32",
            "example":15
        },
        "ageFromUnits":{
            "title":"Age From Units",
            "type":"string",
            "description":"Units used for the lower age bound.",
            "example":"years"
        },
        "ageToUnits":{
            "title":"Age To Units",
            "type":"string",
            "description":"Units used for the upper age bound.",
            "example":"years"
        },
        "race":{
            "title":"Race",
            "type":"string",
            "description":"Race targeted by the lab normal.",
            "example":"Asian"
        },
        "fasting":{
            "title":"Fasting",
            "type":"string",
            "description":"Fasting flag for the lab normal.",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "effectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date when the lab normal becomes effective.",
            "format":"date",
            "example":"2025-01-01"
        }
    },
    "description":"Schema describing a lab normal entry."
}

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LabNormalTO v1.0
  Title: LabNormalTO v1.0

  Schema describing a lab normal entry.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LabNormalTO"
    }
}

Nested Schema : LabNormalTO v1.0

Type: object

Title: LabNormalTO v1.0

Schema describing a lab normal entry.

Show Source

• ageFrom(required): integer (int32)
  Title: Age From

  Lower bound for the age range.

  Example: 5
• ageFromUnits(required): string
  Title: Age From Units

  Units used for the lower age bound.

  Example: years
• ageTo(required): integer (int32)
  Title: Age To

  Upper bound for the age range.

  Example: 15
• ageToUnits(required): string
  Title: Age To Units

  Units used for the upper age bound.

  Example: years
• effectiveDate(required): string (date)
  Title: Effective Date

  Date when the lab normal becomes effective.

  Example: 2025-01-01
• fasting: string
  Title: Fasting

  Allowed Values: [ "Yes", "No" ]

  Fasting flag for the lab normal.

  Example: Yes
• gender: string
  Title: Gender

  Gender applicable to the lab normal.

  Example: Female
• highRange: string
  Title: High Range

  Upper limit for the lab normal range.

  Example: 100
• labNormalId: string (uuid)
• labUnit: string
  Title: Lab Unit

  Measurement unit for the lab test.

  Example: mg/dL
• lowRange: string
  Title: Low Range

  Lower limit for the lab normal range.

  Example: 10
• race: string
  Title: Race

  Race targeted by the lab normal.

  Example: Asian
• sequence(required): integer (int32)
  Title: Sequence

  Minimum Value: 1

  Ordering number for the lab normal.

  Example: 5
• standardResult: string
  Title: Standard Result

  Standard result value for the lab normal.

  Example: 100
• test(required): string
  Title: Test

  Name of the lab test.

  Example: HEMOGLOBIN

{
    "title":"LabNormalTO v1.0",
    "required":[
        "ageFrom",
        "ageFromUnits",
        "ageTo",
        "ageToUnits",
        "effectiveDate",
        "sequence",
        "test"
    ],
    "type":"object",
    "properties":{
        "labNormalId":{
            "type":"string",
            "format":"uuid"
        },
        "sequence":{
            "title":"Sequence",
            "minimum":1,
            "type":"integer",
            "description":"Ordering number for the lab normal.",
            "format":"int32",
            "example":5
        },
        "test":{
            "title":"Test",
            "type":"string",
            "description":"Name of the lab test.",
            "example":"HEMOGLOBIN"
        },
        "labUnit":{
            "title":"Lab Unit",
            "type":"string",
            "description":"Measurement unit for the lab test.",
            "example":"mg/dL"
        },
        "lowRange":{
            "title":"Low Range",
            "type":"string",
            "description":"Lower limit for the lab normal range.",
            "example":"10"
        },
        "highRange":{
            "title":"High Range",
            "type":"string",
            "description":"Upper limit for the lab normal range.",
            "example":"100"
        },
        "standardResult":{
            "title":"Standard Result",
            "type":"string",
            "description":"Standard result value for the lab normal.",
            "example":"100"
        },
        "gender":{
            "title":"Gender",
            "type":"string",
            "description":"Gender applicable to the lab normal.",
            "example":"Female"
        },
        "ageFrom":{
            "title":"Age From",
            "type":"integer",
            "description":"Lower bound for the age range.",
            "format":"int32",
            "example":5
        },
        "ageTo":{
            "title":"Age To",
            "type":"integer",
            "description":"Upper bound for the age range.",
            "format":"int32",
            "example":15
        },
        "ageFromUnits":{
            "title":"Age From Units",
            "type":"string",
            "description":"Units used for the lower age bound.",
            "example":"years"
        },
        "ageToUnits":{
            "title":"Age To Units",
            "type":"string",
            "description":"Units used for the upper age bound.",
            "example":"years"
        },
        "race":{
            "title":"Race",
            "type":"string",
            "description":"Race targeted by the lab normal.",
            "example":"Asian"
        },
        "fasting":{
            "title":"Fasting",
            "type":"string",
            "description":"Fasting flag for the lab normal.",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "effectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date when the lab normal becomes effective.",
            "format":"date",
            "example":"2025-01-01"
        }
    },
    "description":"Schema describing a lab normal entry."
}

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Error Response

Back to Top