REST API for Clinical One Platform

Update status of created queries or discrepancies

put

/ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query

Updates the status of Central Coding created queries or discrepancies. Allowed statuses are open, close, delete.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml

Root Schema : schema

Type: object

Show Source

authenticationTrialName: string
requestList(required): object DiscrepancyUpdateRequestList
transactionId: string
transactionUserName: string
validateOnly: boolean

{
    "required":[
        "requestList"
    ],
    "type":"object",
    "properties":{
        "authenticationTrialName":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "transactionId":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "transactionUserName":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "validateOnly":{
            "type":"boolean",
            "xml":{
                "name":"ValidateOnly"
            }
        },
        "requestList":{
            "$ref":"#/components/schemas/DiscrepancyUpdateRequestList"
        }
    },
    "xml":{
        "name":"UpdateUpdateRequest",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyUpdateRequestList

Type: object

Show Source

discrepancyUpdateRequest(required): array DiscrepancyUpdateRequest

{
    "required":[
        "discrepancyUpdateRequest"
    ],
    "type":"object",
    "properties":{
        "discrepancyUpdateRequest":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyUpdateRequest"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyUpdateRequest"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateRequest

Type: array

Show Source

Array of: object DiscrepancyUpdateRequest

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyUpdateRequest"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyUpdateRequest"
    }
}

Nested Schema : DiscrepancyUpdateRequest

Type: object

Show Source

guid(required): string
reason(required): string
reissue: boolean
revision(required): number (double)
state(required): string

Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]

{
    "required":[
        "guid",
        "reason",
        "revision",
        "state"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "state":{
            "type":"string",
            "xml":{
                "name":"State"
            },
            "enum":[
                "CANDIDATE",
                "OPENED",
                "ANSWERED",
                "CLOSED",
                "DELETED",
                "SPONSOR_CONFLICT",
                "SITE_CONFLICT"
            ]
        },
        "reissue":{
            "type":"boolean",
            "xml":{
                "name":"Reissue"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        }
    }
}

Response

Supported Media Types

application/xml

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object UpdateResponseUpdateResult

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

Nested Schema : UpdateResponseUpdateResult

Type: object

Show Source

errorList: object DiscrepancyUpdateErrorList
resultList(required): object DiscrepancyUpdateResultList
validated: boolean

{
    "required":[
        "resultList"
    ],
    "type":"object",
    "properties":{
        "validated":{
            "type":"boolean",
            "xml":{
                "name":"Validated"
            }
        },
        "resultList":{
            "$ref":"#/components/schemas/DiscrepancyUpdateResultList"
        },
        "errorList":{
            "$ref":"#/components/schemas/DiscrepancyUpdateErrorList"
        }
    },
    "xml":{
        "name":"UpdateResponseUpdateResult",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyUpdateErrorList

Type: object

Show Source

discrepancyUpdateError(required): array DiscrepancyUpdateError

{
    "required":[
        "discrepancyUpdateError"
    ],
    "type":"object",
    "properties":{
        "discrepancyUpdateError":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyUpdateError"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyUpdateError"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateResultList

Type: object

Show Source

discrepancyUpdateResult(required): array DiscrepancyUpdateResult

{
    "required":[
        "discrepancyUpdateResult"
    ],
    "type":"object",
    "properties":{
        "discrepancyUpdateResult":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyUpdateResult"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyIdentifier"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateError

Type: array

Show Source

Array of: object DiscrepancyUpdateError

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyUpdateError"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyUpdateError"
    }
}

Nested Schema : DiscrepancyUpdateError

Type: object

Show Source

discrepancyUpdateRequest(required): object DiscrepancyUpdateRequest
message(required): string
messageId(required): string

{
    "required":[
        "discrepancyUpdateRequest",
        "message",
        "messageId"
    ],
    "type":"object",
    "properties":{
        "messageId":{
            "type":"string",
            "xml":{
                "name":"MessageId"
            }
        },
        "message":{
            "type":"string",
            "xml":{
                "name":"Message"
            }
        },
        "discrepancyUpdateRequest":{
            "$ref":"#/components/schemas/DiscrepancyUpdateRequest"
        }
    }
}

Nested Schema : DiscrepancyUpdateRequest

Type: object

Show Source

guid(required): string
reason(required): string
reissue: boolean
revision(required): number (double)
state(required): string

Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]

{
    "required":[
        "guid",
        "reason",
        "revision",
        "state"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "state":{
            "type":"string",
            "xml":{
                "name":"State"
            },
            "enum":[
                "CANDIDATE",
                "OPENED",
                "ANSWERED",
                "CLOSED",
                "DELETED",
                "SPONSOR_CONFLICT",
                "SITE_CONFLICT"
            ]
        },
        "reissue":{
            "type":"boolean",
            "xml":{
                "name":"Reissue"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateResult

Type: array

Show Source

Array of: object DiscrepancyIdentifier

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyUpdateResult"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyIdentifier"
    }
}

Nested Schema : DiscrepancyIdentifier

Type: object

Show Source

guid(required): string
revision(required): number (double)

{
    "required":[
        "guid",
        "revision"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        }
    }
}

400 Response

Bad Request

Root Schema : UpdateResponseUpdateResult

Type: object

Show Source

errorList: object DiscrepancyUpdateErrorList
resultList(required): object DiscrepancyUpdateResultList
validated: boolean

{
    "required":[
        "resultList"
    ],
    "type":"object",
    "properties":{
        "validated":{
            "type":"boolean",
            "xml":{
                "name":"Validated"
            }
        },
        "resultList":{
            "$ref":"#/components/schemas/DiscrepancyUpdateResultList"
        },
        "errorList":{
            "$ref":"#/components/schemas/DiscrepancyUpdateErrorList"
        }
    },
    "xml":{
        "name":"UpdateResponseUpdateResult",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyUpdateErrorList

Type: object

Show Source

discrepancyUpdateError(required): array DiscrepancyUpdateError

{
    "required":[
        "discrepancyUpdateError"
    ],
    "type":"object",
    "properties":{
        "discrepancyUpdateError":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyUpdateError"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyUpdateError"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateResultList

Type: object

Show Source

discrepancyUpdateResult(required): array DiscrepancyUpdateResult

{
    "required":[
        "discrepancyUpdateResult"
    ],
    "type":"object",
    "properties":{
        "discrepancyUpdateResult":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyUpdateResult"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyIdentifier"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateError

Type: array

Show Source

Array of: object DiscrepancyUpdateError

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyUpdateError"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyUpdateError"
    }
}

Nested Schema : DiscrepancyUpdateError

Type: object

Show Source

discrepancyUpdateRequest(required): object DiscrepancyUpdateRequest
message(required): string
messageId(required): string

{
    "required":[
        "discrepancyUpdateRequest",
        "message",
        "messageId"
    ],
    "type":"object",
    "properties":{
        "messageId":{
            "type":"string",
            "xml":{
                "name":"MessageId"
            }
        },
        "message":{
            "type":"string",
            "xml":{
                "name":"Message"
            }
        },
        "discrepancyUpdateRequest":{
            "$ref":"#/components/schemas/DiscrepancyUpdateRequest"
        }
    }
}

Nested Schema : DiscrepancyUpdateRequest

Type: object

Show Source

guid(required): string
reason(required): string
reissue: boolean
revision(required): number (double)
state(required): string

Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]

{
    "required":[
        "guid",
        "reason",
        "revision",
        "state"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "state":{
            "type":"string",
            "xml":{
                "name":"State"
            },
            "enum":[
                "CANDIDATE",
                "OPENED",
                "ANSWERED",
                "CLOSED",
                "DELETED",
                "SPONSOR_CONFLICT",
                "SITE_CONFLICT"
            ]
        },
        "reissue":{
            "type":"boolean",
            "xml":{
                "name":"Reissue"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        }
    }
}

Nested Schema : DiscrepancyUpdateResult

Type: array

Show Source

Array of: object DiscrepancyIdentifier

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyUpdateResult"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyIdentifier"
    }
}

Nested Schema : DiscrepancyIdentifier

Type: object

Show Source

guid(required): string
revision(required): number (double)

{
    "required":[
        "guid",
        "revision"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        }
    }
}