Jump to

• Request
• Response

V1.0

get

/ec-designer-svc/rest/v1.0/studies/identity

Retrieves a study's identity based on protocol ID.

Request

Query Parameters

• protocolId: string
  Study protocol ID (UUID, 32-character uppercase hexadecimal string). Optional.

  Default Value:

  Example:

  PROTOCOL_001

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : StudyIdentityDto

Type: object

Show Source

• id: string (uuid)
  Study Id
• protocolDescription: string
  Study protocol description
• protocolNumber: string
  Study protocol number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Study Id",
            "format":"uuid"
        },
        "protocolNumber":{
            "type":"string",
            "description":"Study protocol number"
        },
        "protocolDescription":{
            "type":"string",
            "description":"Study protocol description"
        }
    }
}

Examples

Select an example successResponse

404 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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 : details

Type: object

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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 : details

Type: object

Back to Top