Jump to

• Request
• Response

[Deprecated]: V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Deprecated: Retrieve data elements to be coded based on 'codeType' parameter. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Request

Query Parameters

• bookMark: string
• codeType: string
  Type of coded questions to be fetched. Allowed values: 'NeedsCodingOrDeleted' and 'NeedsCoding'.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object CodedDerrivedItemsRequest
  Request object for inserting or updating coded values for a source, with a list of codes applied.

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

Nested Schema : CodedDerrivedItemsRequest

Type: object

Request object for inserting or updating coded values for a source, with a list of codes applied.

Show Source

• codeValuesList: object codeValuesList
  Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result.
• source_propertyId: string
  Source property Unique identifier(UUID, 32-character uppercase hexadecimal string). Must be unique per data context.

  Example: A3B9C7D6E8F041BBA1C7B3C8E182D43A
• source_value(required): string
  Minimum Length: 0

  Maximum Length: 4000

  The original/raw value from the source.

  Example: ALT

{
    "required":[
        "source_value"
    ],
    "type":"object",
    "properties":{
        "source_propertyId":{
            "type":"string",
            "description":"Source property Unique identifier(UUID, 32-character uppercase hexadecimal string). Must be unique per data context.",
            "example":"A3B9C7D6E8F041BBA1C7B3C8E182D43A"
        },
        "source_value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The original/raw value from the source.",
            "example":"ALT"
        },
        "codeValuesList":{
            "required":[
                "code_value"
            ],
            "type":"object",
            "properties":{
                "coding_info_id":{
                    "type":"string",
                    "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding info used to derive the code.",
                    "example":"3A1A5E8B0F894A9CA9F324D04B162F23"
                },
                "item_id":{
                    "type":"string",
                    "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
                    "example":"5B3B7E0ED4F24E30B5A3A44C5A896C90"
                },
                "target_id":{
                    "type":"string",
                    "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding result target.",
                    "example":"F843B5478028498882E3AF11FEBA3F2A"
                },
                "code_value":{
                    "maxLength":4000,
                    "minLength":0,
                    "type":"string",
                    "description":"The actual code value derived from the coding process.",
                    "example":"R79.0"
                }
            },
            "description":"Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result."
        }
    },
    "description":"Request object for inserting or updating coded values for a source, with a list of codes applied."
}

Nested Schema : codeValuesList

Type: object

Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result.

Show Source

• code_value(required): string
  Minimum Length: 0

  Maximum Length: 4000

  The actual code value derived from the coding process.

  Example: R79.0
• coding_info_id: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding info used to derive the code.

  Example: 3A1A5E8B0F894A9CA9F324D04B162F23
• item_id: string
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: 5B3B7E0ED4F24E30B5A3A44C5A896C90
• target_id: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding result target.

  Example: F843B5478028498882E3AF11FEBA3F2A

{
    "required":[
        "code_value"
    ],
    "type":"object",
    "properties":{
        "coding_info_id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding info used to derive the code.",
            "example":"3A1A5E8B0F894A9CA9F324D04B162F23"
        },
        "item_id":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"5B3B7E0ED4F24E30B5A3A44C5A896C90"
        },
        "target_id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding result target.",
            "example":"F843B5478028498882E3AF11FEBA3F2A"
        },
        "code_value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The actual code value derived from the coding process.",
            "example":"R79.0"
        }
    },
    "description":"Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result."
}

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