Jump to

• Request
• Response

Get all labs associated with a given site

get

/ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs

Paginated API to retrieves all labs associated with a given site. Rights required: LabGet.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• studyId(required): string
  The ID of the study.

Query Parameters

• limit: integer(int32)
  Number of rows to return.
• offset: integer(int32)
  Row number to start from.
• siteId: string
  Name search filter for site

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LabResponse

Type: object

Show Source

• labAddresses: array labAddresses
• labDetails: object LabDetailsDto
• labProperties: array labProperties

{
    "type":"object",
    "properties":{
        "labDetails":{
            "$ref":"#/components/schemas/LabDetailsDto"
        },
        "labAddresses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDetailsDto"
            }
        },
        "labProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : labAddresses

Type: array

Show Source

• Array of: object SDFAddressAssociationDetailsDto

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

Nested Schema : LabDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• labId: string (uuid)
• labIdName: string
  Minimum Length: 0

  Maximum Length: 50
• labName: string
• labStatus: string (uuid)
• objectVersionNumber: number
• oldSdfId: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• softwareVersionNumber: number
• studyLabId: string (uuid)
• userId: string (uuid)
• vendorId(required): string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "vendorId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "studyLabId":{
            "type":"string",
            "format":"uuid"
        },
        "labId":{
            "type":"string",
            "format":"uuid"
        },
        "labName":{
            "type":"string"
        },
        "labStatus":{
            "type":"string",
            "format":"uuid"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "vendorId":{
            "type":"string",
            "format":"uuid"
        },
        "labIdName":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : labProperties

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : SDFAddressAssociationDetailsDto

Type: object

Show Source

• addressCity: string
• addressCountry: string (uuid)
• addressCountryName: string
• addressPostalCode: string
• addressStateOrProvOrCounty: string (uuid)
• addressStateOrProvOrCountyName: string
• addressStreet1: string
• addressStreet2: string
• addressTypeId(required): string (uuid)
• addressTypeIdCodeValue: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityAddressAssociationId(required): string (uuid)
• entityAddressProperties: array entityAddressProperties
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfAddressProperties: array sdfAddressProperties
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "addressTypeId",
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "type":"string"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressPostalCode":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressStateOrProvOrCountyName":{
            "type":"string"
        },
        "addressCountry":{
            "type":"string",
            "format":"uuid"
        },
        "addressCountryName":{
            "type":"string"
        },
        "entityAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        },
        "sdfAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : entityAddressProperties

Type: array

Show Source

• Array of: object PropertyDto

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

Nested Schema : sdfAddressProperties

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : PropertyDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string (uuid)
• entityType: string
  Minimum Length: 0

  Maximum Length: 50
• id: string (uuid)
• objectVersionNumber: number
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "propertyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "propertyValue":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        }
    }
}

Nested Schema : SDFPropertyDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 1024
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "propertyValue":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : LabResponse

Type: object

Show Source

• labAddresses: array labAddresses
• labDetails: object LabDetailsDto
• labProperties: array labProperties

{
    "type":"object",
    "properties":{
        "labDetails":{
            "$ref":"#/components/schemas/LabDetailsDto"
        },
        "labAddresses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDetailsDto"
            }
        },
        "labProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : labAddresses

Type: array

Show Source

• Array of: object SDFAddressAssociationDetailsDto

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

Nested Schema : LabDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• labId: string (uuid)
• labIdName: string
  Minimum Length: 0

  Maximum Length: 50
• labName: string
• labStatus: string (uuid)
• objectVersionNumber: number
• oldSdfId: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• softwareVersionNumber: number
• studyLabId: string (uuid)
• userId: string (uuid)
• vendorId(required): string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "vendorId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "studyLabId":{
            "type":"string",
            "format":"uuid"
        },
        "labId":{
            "type":"string",
            "format":"uuid"
        },
        "labName":{
            "type":"string"
        },
        "labStatus":{
            "type":"string",
            "format":"uuid"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "vendorId":{
            "type":"string",
            "format":"uuid"
        },
        "labIdName":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : labProperties

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : SDFAddressAssociationDetailsDto

Type: object

Show Source

• addressCity: string
• addressCountry: string (uuid)
• addressCountryName: string
• addressPostalCode: string
• addressStateOrProvOrCounty: string (uuid)
• addressStateOrProvOrCountyName: string
• addressStreet1: string
• addressStreet2: string
• addressTypeId(required): string (uuid)
• addressTypeIdCodeValue: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityAddressAssociationId(required): string (uuid)
• entityAddressProperties: array entityAddressProperties
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfAddressProperties: array sdfAddressProperties
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "addressTypeId",
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "type":"string"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressPostalCode":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressStateOrProvOrCountyName":{
            "type":"string"
        },
        "addressCountry":{
            "type":"string",
            "format":"uuid"
        },
        "addressCountryName":{
            "type":"string"
        },
        "entityAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        },
        "sdfAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : entityAddressProperties

Type: array

Show Source

• Array of: object PropertyDto

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

Nested Schema : sdfAddressProperties

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : PropertyDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string (uuid)
• entityType: string
  Minimum Length: 0

  Maximum Length: 50
• id: string (uuid)
• objectVersionNumber: number
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "propertyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "propertyValue":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        }
    }
}

Nested Schema : SDFPropertyDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 1024
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "propertyValue":{
            "maxLength":"1024",
            "minLength":"0",
            "type":"string"
        }
    }
}

Back to Top