Jump to

• Request
• Response

Get data elements to be coded by codeType

get

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

Retrieve 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 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: string
  Minimum Length: 1

  Maximum Length: 255
• codeGroupId: string (uuid)
• codeId: string (uuid)
• codeLabel: string
  Minimum Length: 1

  Maximum Length: 32767
• codeValue: string
  Minimum Length: 1

  Maximum Length: 32767
• comment: string
• customizationType: string
• hidden: boolean
• id: string (uuid)
• language: string
  Minimum Length: 1

  Maximum Length: 10
• locale: string
  Minimum Length: 1

  Maximum Length: 255
• loinc: string
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• optlock: string (date-time)
• reason: string
• sequence: number
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "optlock":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "codeValue":{
            "maxLength":"32767",
            "minLength":"1",
            "type":"string"
        },
        "codeLabel":{
            "maxLength":"32767",
            "minLength":"1",
            "type":"string"
        },
        "code":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "sequence":{
            "type":"number"
        },
        "language":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string"
        },
        "codeGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "hidden":{
            "type":"boolean"
        },
        "customizationType":{
            "type":"string"
        },
        "loinc":{
            "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