Jump to

• Request
• Response

v2.0

post

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

Compared with v1, this version creates lab-to-study-site associations using explicit site and lab identifier lists.

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : SiteLabsAssociationRequest v2.0

Type: object

Title: SiteLabsAssociationRequest v2.0

Payload containing site and lab identifiers for association.

Show Source

• labs(required): array Labs
  Title: Labs

  Lab identifiers to associate with the sites.
• sites(required): array Sites
  Title: Sites

  Study site identifiers to associate.

{
    "title":"SiteLabsAssociationRequest v2.0",
    "required":[
        "labs",
        "sites"
    ],
    "type":"object",
    "properties":{
        "sites":{
            "title":"Sites",
            "type":"array",
            "description":"Study site identifiers to associate.",
            "format":"uuid",
            "example":"B1B8327AFAA6412287106192AB5984EF",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "labs":{
            "title":"Labs",
            "type":"array",
            "description":"Lab identifiers to associate with the sites.",
            "format":"uuid",
            "example":"B1B8327AFAA6412287106192AB5984EF",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Payload containing site and lab identifiers for association."
}

Nested Schema : Labs

Type: array

Title: Labs

Lab identifiers to associate with the sites.

Show Source

• Array of: string(uuid)

{
    "title":"Labs",
    "type":"array",
    "description":"Lab identifiers to associate with the sites.",
    "format":"uuid",
    "example":"B1B8327AFAA6412287106192AB5984EF",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

B1B8327AFAA6412287106192AB5984EF

Nested Schema : Sites

Type: array

Title: Sites

Study site identifiers to associate.

Show Source

• Array of: string(uuid)

{
    "title":"Sites",
    "type":"array",
    "description":"Study site identifiers to associate.",
    "format":"uuid",
    "example":"B1B8327AFAA6412287106192AB5984EF",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

B1B8327AFAA6412287106192AB5984EF

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SiteLabsAssociationResponse v2.0

Type: object

Title: SiteLabsAssociationResponse v2.0

Response containing the site and lab identifiers after association.

Show Source

• labs(required): array Labs
  Title: Labs

  Lab identifiers returned in the response.
• sites(required): array Sites
  Title: Sites

  Study site identifiers returned in the response.

{
    "title":"SiteLabsAssociationResponse v2.0",
    "required":[
        "labs",
        "sites"
    ],
    "type":"object",
    "properties":{
        "sites":{
            "title":"Sites",
            "type":"array",
            "description":"Study site identifiers returned in the response.",
            "format":"uuid",
            "example":"B1B8327AFAA6412287106192AB5984EF",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "labs":{
            "title":"Labs",
            "type":"array",
            "description":"Lab identifiers returned in the response.",
            "format":"uuid",
            "example":"B1B8327AFAA6412287106192AB5984EF",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Response containing the site and lab identifiers after association."
}

Nested Schema : Labs

Type: array

Title: Labs

Lab identifiers returned in the response.

Show Source

• Array of: string(uuid)

{
    "title":"Labs",
    "type":"array",
    "description":"Lab identifiers returned in the response.",
    "format":"uuid",
    "example":"B1B8327AFAA6412287106192AB5984EF",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

B1B8327AFAA6412287106192AB5984EF

Nested Schema : Sites

Type: array

Title: Sites

Study site identifiers returned in the response.

Show Source

• Array of: string(uuid)

{
    "title":"Sites",
    "type":"array",
    "description":"Study site identifiers returned in the response.",
    "format":"uuid",
    "example":"B1B8327AFAA6412287106192AB5984EF",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

B1B8327AFAA6412287106192AB5984EF

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