Jump to

• Request
• Response

Create or update lab normals

put

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals

Creates or updates lab normals. Right: LabNormalPost.

Request

Path Parameters

• labId(required): string(uuid)
  The lab ID for which to create lab normals.
• mode(required): string
  Mode of the study. Accepts active, test, or training.
• studyId(required): string(uuid)
  The ID of the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object LabNormalTO
  Contains details for creating a lab normal for a lab

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

Nested Schema : LabNormalTO

Type: object

Contains details for creating a lab normal for a lab

Show Source

• ageFrom(required): integer (int32)
  Lower limit of age

  Example: 5
• ageFromUnits(required): string
  Units type for age from values

  Example: months
• ageTo(required): integer (int32)
  Higher limit of age

  Example: 5
• ageToUnits(required): string
  Units type for age to values

  Example: months
• effectiveDate(required): string
  Effective date

  Example: 20-jan-2020
• fasting: string
  Allowed Values: [ "Yes", "No" ]

  Whether fasting or not

  Example: Yes
• gender: string
  Gender

  Example: Male
• highRange: string
  High range

  Example: 100
• labNormalId: string (uuid)
  Unique Id for lab normal.
• labUnit: string
  Lab unit type

  Example: mg
• lowRange: string
  Low range

  Example: 10
• race: string
  Race

  Example: asian
• sequence(required): integer (int32)
  Minimum Value: 1

  Sequence number

  Example: 5
• standardResult: string
  Standard result

  Example: 100
• test(required): string
  Test name for a lab normal

  Example: haemoglobin

{
    "required":[
        "ageFrom",
        "ageFromUnits",
        "ageTo",
        "ageToUnits",
        "effectiveDate",
        "sequence",
        "test"
    ],
    "type":"object",
    "properties":{
        "labNormalId":{
            "type":"string",
            "description":"Unique Id for lab normal.",
            "format":"uuid"
        },
        "sequence":{
            "minimum":"1",
            "type":"integer",
            "description":"Sequence number",
            "format":"int32",
            "example":"5"
        },
        "test":{
            "type":"string",
            "description":"Test name for a lab normal",
            "example":"haemoglobin"
        },
        "labUnit":{
            "type":"string",
            "description":"Lab unit type",
            "example":"mg"
        },
        "lowRange":{
            "type":"string",
            "description":"Low range",
            "example":"10"
        },
        "highRange":{
            "type":"string",
            "description":"High range",
            "example":"100"
        },
        "standardResult":{
            "type":"string",
            "description":"Standard result",
            "example":"100"
        },
        "gender":{
            "type":"string",
            "description":"Gender",
            "example":"Male"
        },
        "ageFrom":{
            "type":"integer",
            "description":"Lower limit of age",
            "format":"int32",
            "example":"5"
        },
        "ageTo":{
            "type":"integer",
            "description":"Higher limit of age",
            "format":"int32",
            "example":"5"
        },
        "ageFromUnits":{
            "type":"string",
            "description":"Units type for age from values",
            "example":"months"
        },
        "ageToUnits":{
            "type":"string",
            "description":"Units type for age to values",
            "example":"months"
        },
        "race":{
            "type":"string",
            "description":"Race",
            "example":"asian"
        },
        "fasting":{
            "type":"string",
            "description":"Whether fasting or not",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "effectiveDate":{
            "type":"string",
            "description":"Effective date",
            "example":"20-jan-2020"
        }
    },
    "description":"Contains details for creating a lab normal for a lab"
}

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
  Contains details for creating a lab normal for a lab

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

Nested Schema : LabNormalTO

Type: object

Contains details for creating a lab normal for a lab

Show Source

• ageFrom(required): integer (int32)
  Lower limit of age

  Example: 5
• ageFromUnits(required): string
  Units type for age from values

  Example: months
• ageTo(required): integer (int32)
  Higher limit of age

  Example: 5
• ageToUnits(required): string
  Units type for age to values

  Example: months
• effectiveDate(required): string
  Effective date

  Example: 20-jan-2020
• fasting: string
  Allowed Values: [ "Yes", "No" ]

  Whether fasting or not

  Example: Yes
• gender: string
  Gender

  Example: Male
• highRange: string
  High range

  Example: 100
• labNormalId: string (uuid)
  Unique Id for lab normal.
• labUnit: string
  Lab unit type

  Example: mg
• lowRange: string
  Low range

  Example: 10
• race: string
  Race

  Example: asian
• sequence(required): integer (int32)
  Minimum Value: 1

  Sequence number

  Example: 5
• standardResult: string
  Standard result

  Example: 100
• test(required): string
  Test name for a lab normal

  Example: haemoglobin

{
    "required":[
        "ageFrom",
        "ageFromUnits",
        "ageTo",
        "ageToUnits",
        "effectiveDate",
        "sequence",
        "test"
    ],
    "type":"object",
    "properties":{
        "labNormalId":{
            "type":"string",
            "description":"Unique Id for lab normal.",
            "format":"uuid"
        },
        "sequence":{
            "minimum":"1",
            "type":"integer",
            "description":"Sequence number",
            "format":"int32",
            "example":"5"
        },
        "test":{
            "type":"string",
            "description":"Test name for a lab normal",
            "example":"haemoglobin"
        },
        "labUnit":{
            "type":"string",
            "description":"Lab unit type",
            "example":"mg"
        },
        "lowRange":{
            "type":"string",
            "description":"Low range",
            "example":"10"
        },
        "highRange":{
            "type":"string",
            "description":"High range",
            "example":"100"
        },
        "standardResult":{
            "type":"string",
            "description":"Standard result",
            "example":"100"
        },
        "gender":{
            "type":"string",
            "description":"Gender",
            "example":"Male"
        },
        "ageFrom":{
            "type":"integer",
            "description":"Lower limit of age",
            "format":"int32",
            "example":"5"
        },
        "ageTo":{
            "type":"integer",
            "description":"Higher limit of age",
            "format":"int32",
            "example":"5"
        },
        "ageFromUnits":{
            "type":"string",
            "description":"Units type for age from values",
            "example":"months"
        },
        "ageToUnits":{
            "type":"string",
            "description":"Units type for age to values",
            "example":"months"
        },
        "race":{
            "type":"string",
            "description":"Race",
            "example":"asian"
        },
        "fasting":{
            "type":"string",
            "description":"Whether fasting or not",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "effectiveDate":{
            "type":"string",
            "description":"Effective date",
            "example":"20-jan-2020"
        }
    },
    "description":"Contains details for creating a lab normal for a lab"
}

400 Response

Bad request.

Body ()

Root Schema : schema

Type: object

Show Source

• allowedMethods: array allowedMethods
  Unique Items Required: true
• cookies: object cookies
  Additional Properties Allowed: additionalProperties
• date: string (date-time)
• entity: object entity
• entityTag: object entityTag
• headers: object headers
  Additional Properties Allowed: additionalProperties
• language: object language
• lastModified: string (date-time)
• length: integer (int32)
• links: array links
  Unique Items Required: true
• location: string (uri)
• mediaType: object mediaType
• metadata: object metadata
  Additional Properties Allowed: additionalProperties
• status: integer (int32)
• statusInfo: object statusInfo
• stringHeaders: object stringHeaders
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "params":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"string"
                        }
                    },
                    "title":{
                        "type":"string"
                    },
                    "rel":{
                        "type":"string"
                    },
                    "rels":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "uri":{
                        "type":"string",
                        "format":"uri"
                    },
                    "uriBuilder":{
                        "type":"object"
                    },
                    "type":{
                        "type":"string"
                    }
                }
            }
        },
        "statusInfo":{
            "type":"object",
            "properties":{
                "family":{
                    "type":"string",
                    "enum":[
                        "INFORMATIONAL",
                        "SUCCESSFUL",
                        "REDIRECTION",
                        "CLIENT_ERROR",
                        "SERVER_ERROR",
                        "OTHER"
                    ]
                },
                "reasonPhrase":{
                    "type":"string"
                },
                "statusCode":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        },
        "mediaType":{
            "type":"object",
            "properties":{
                "type":{
                    "type":"string"
                },
                "subtype":{
                    "type":"string"
                },
                "parameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "wildcardType":{
                    "type":"boolean"
                },
                "wildcardSubtype":{
                    "type":"boolean"
                }
            }
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "value":{
                        "type":"string"
                    },
                    "version":{
                        "type":"integer",
                        "format":"int32"
                    },
                    "path":{
                        "type":"string"
                    },
                    "domain":{
                        "type":"string"
                    },
                    "comment":{
                        "type":"string"
                    },
                    "maxAge":{
                        "type":"integer",
                        "format":"int32"
                    },
                    "expiry":{
                        "type":"string",
                        "format":"date-time"
                    },
                    "secure":{
                        "type":"boolean"
                    },
                    "httpOnly":{
                        "type":"boolean"
                    }
                }
            }
        },
        "entityTag":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string"
                },
                "weak":{
                    "type":"boolean"
                }
            }
        },
        "stringHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                }
            }
        },
        "location":{
            "type":"string",
            "format":"uri"
        }
    }
}

Nested Schema : allowedMethods

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : cookies

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "value":{
                "type":"string"
            },
            "version":{
                "type":"integer",
                "format":"int32"
            },
            "path":{
                "type":"string"
            },
            "domain":{
                "type":"string"
            },
            "comment":{
                "type":"string"
            },
            "maxAge":{
                "type":"integer",
                "format":"int32"
            },
            "expiry":{
                "type":"string",
                "format":"date-time"
            },
            "secure":{
                "type":"boolean"
            },
            "httpOnly":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : entityTag

Type: object

Show Source

• value: string
• weak: boolean

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "weak":{
            "type":"boolean"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : language

Type: object

Show Source

• country: string
• displayCountry: string
• displayLanguage: string
• displayName: string
• displayScript: string
• displayVariant: string
• extensionKeys: array extensionKeys
  Unique Items Required: true
• iso3Country: string
• iso3Language: string
• language: string
• script: string
• unicodeLocaleAttributes: array unicodeLocaleAttributes
  Unique Items Required: true
• unicodeLocaleKeys: array unicodeLocaleKeys
  Unique Items Required: true
• variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

• Array of: object items

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "params":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "title":{
                "type":"string"
            },
            "rel":{
                "type":"string"
            },
            "rels":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "uri":{
                "type":"string",
                "format":"uri"
            },
            "uriBuilder":{
                "type":"object"
            },
            "type":{
                "type":"string"
            }
        }
    }
}

Nested Schema : mediaType

Type: object

Show Source

• parameters: object parameters
  Additional Properties Allowed: additionalProperties
• subtype: string
• type: string
• wildcardSubtype: boolean
• wildcardType: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean"
        },
        "wildcardSubtype":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : statusInfo

Type: object

Show Source

• family: string
  Allowed Values: [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
• reasonPhrase: string
• statusCode: integer (int32)

{
    "type":"object",
    "properties":{
        "family":{
            "type":"string",
            "enum":[
                "INFORMATIONAL",
                "SUCCESSFUL",
                "REDIRECTION",
                "CLIENT_ERROR",
                "SERVER_ERROR",
                "OTHER"
            ]
        },
        "reasonPhrase":{
            "type":"string"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : stringHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Show Source

• comment: string
• domain: string
• expiry: string (date-time)
• httpOnly: boolean
• maxAge: integer (int32)
• name: string
• path: string
• secure: boolean
• value: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "path":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "maxAge":{
            "type":"integer",
            "format":"int32"
        },
        "expiry":{
            "type":"string",
            "format":"date-time"
        },
        "secure":{
            "type":"boolean"
        },
        "httpOnly":{
            "type":"boolean"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• params: object params
  Additional Properties Allowed: additionalProperties
• rel: string
• rels: array rels
• title: string
• type: string
• uri: string (uri)
• uriBuilder: object uriBuilder

{
    "type":"object",
    "properties":{
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "title":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "uriBuilder":{
            "type":"object"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : rels

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : uriBuilder

Type: object

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top