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
  Indicates the operational mode of the study. Accepted values: active, test, 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 of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1A30945DC9A3462B9CE95C7BC0C2FBDC

• subjectId(required): string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top