Jump to

• Request
• Response

Get data elements to be coded using source IDs

post

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

Retrieve data elements to be coded based on codeType parameter and list of source IDs.

Request

Query Parameters

• codeType: string
  type of coded questions to be fetchedallowed values NeedsCodingOrDeleted and NeedsCoding

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• sourceIds: array sourceIds

{
    "type":"object",
    "properties":{
        "sourceIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : sourceIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object CodedDerrivedItemsRequest

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

Nested Schema : CodedDerrivedItemsRequest

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 : DcsResponse

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