Jump to

• Request
• Response

v1.0

post

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/esign/geturl/orgId/{orgId}/subjectId/{subjectId}

Retrieves the URL for the IAMS login page.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• orgId(required): string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) for the organization.

  Example:

  C51D1FE6C3804B6D8F1FE906CB6EAD16

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  1A30945DC9A3462B9CE95C7BC0C2FBDC

• subjectId(required): string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  B8103C474F614AF789ADF3031B516DF2

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : ESignUrlDto

Type: object

Electronic signature URL for the requested subject and organization.

Show Source

• url: string (uri)
  Electronic signature URL.

  Example: https://esign.example.com/process/7AB12CD3E4F5413C9BF46C56A9ED9B7A

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"Electronic signature URL.",
            "format":"uri",
            "example":"https://esign.example.com/process/7AB12CD3E4F5413C9BF46C56A9ED9B7A"
        }
    },
    "description":"Electronic signature URL for the requested subject and organization."
}

Examples

Select an example ESign Url

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top