Jump to

• Request
• Response

Get data elements to be coded by code type

get

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

Retrieves data elements to be coded based on codeType parameter.

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 schema

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

Nested Schema : schema

Type: object

Show Source

• codeValuesList: array codeValuesList
• source_propertyId: string
• source_value(required): string
  Minimum Length: 0

  Maximum Length: 4000

{
    "required":[
        "source_value"
    ],
    "type":"object",
    "properties":{
        "source_propertyId":{
            "type":"string"
        },
        "source_value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "codeValuesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValue"
            }
        }
    }
}

Nested Schema : codeValuesList

Type: array

Show Source

• Array of: object CodeValue

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

Nested Schema : CodeValue

Type: object

Show Source

• code_value(required): string
  Minimum Length: 0

  Maximum Length: 4000
• coding_info_id: string
• item_id: string
• target_id: string

{
    "required":[
        "code_value"
    ],
    "type":"object",
    "properties":{
        "coding_info_id":{
            "type":"string"
        },
        "item_id":{
            "type":"string"
        },
        "target_id":{
            "type":"string"
        },
        "code_value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

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

Nested Schema : details

Type: object

Back to Top