Jump to

• Request
• Response

Create queries/discrepancies

post

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

Creates Central Coding queries/discrepancies. Allowed status is open.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• authenticationTrialName: string
• requestList(required): object DiscrepancyIssueRequestList
• 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/DiscrepancyIssueRequestList"
        }
    },
    "xml":{
        "name":"IssueIssueRequest",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyIssueRequestList

Type: object

Show Source

• discrepancyIssueRequest(required): array DiscrepancyIssueRequest

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

Nested Schema : DiscrepancyIssueRequest

Type: array

Show Source

• Array of: object DiscrepancyIssueRequest

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

Nested Schema : DiscrepancyIssueRequest

Type: object

Show Source

• inFormItemIdentifier(required): object InFormItemIdentifier
• initialState(required): string
  Allowed Values: [ "CANDIDATE", "OPENED" ]
• reason(required): string

{
    "required":[
        "inFormItemIdentifier",
        "initialState",
        "reason"
    ],
    "type":"object",
    "properties":{
        "inFormItemIdentifier":{
            "$ref":"#/components/schemas/InFormItemIdentifier"
        },
        "initialState":{
            "type":"string",
            "xml":{
                "name":"InitialState"
            },
            "enum":[
                "CANDIDATE",
                "OPENED"
            ]
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        }
    }
}

Nested Schema : InFormItemIdentifier

Type: object

Show Source

• inFormItem: object InFormItem
• inFormItemDbuid: string
• inFormItemGuid: string

{
    "type":"object",
    "properties":{
        "inFormItem":{
            "$ref":"#/components/schemas/InFormItem"
        },
        "inFormItemGuid":{
            "type":"string",
            "xml":{
                "name":"InFormItemGuid"
            }
        },
        "inFormItemDbuid":{
            "type":"string",
            "xml":{
                "name":"InFormItemDbuid"
            }
        }
    }
}

Nested Schema : InFormItem

Type: object

Show Source

• form: object RefNameTuple
• itemName: string
• itemSet: object ItemSet
• sectionName: string
• siteId: integer (int64)
• subjectGuid: string
• visit: object RefNameTuple

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"SiteId"
            }
        },
        "subjectGuid":{
            "type":"string",
            "xml":{
                "name":"SubjectGuid"
            }
        },
        "visit":{
            "$ref":"#/components/schemas/RefNameTuple"
        },
        "form":{
            "$ref":"#/components/schemas/RefNameTuple"
        },
        "sectionName":{
            "type":"string",
            "xml":{
                "name":"SectionName"
            }
        },
        "itemSet":{
            "$ref":"#/components/schemas/ItemSet"
        },
        "itemName":{
            "type":"string",
            "xml":{
                "name":"ItemName"
            }
        }
    }
}

Nested Schema : RefNameTuple

Type: object

Show Source

• index: number (double)
• name(required): string
• revision: number (double)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"Name"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "index":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Index"
            }
        }
    }
}

Nested Schema : ItemSet

Type: object

Show Source

• name(required): string
• order: number (double)
• revision: number (double)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"Name"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "order":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Order"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object IssueResponseIssueResult

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

Nested Schema : IssueResponseIssueResult

Type: object

Show Source

• errorList: object DiscrepancyIssueErrorList
• resultList(required): object DiscrepancyResultList

{
    "required":[
        "resultList"
    ],
    "type":"object",
    "properties":{
        "resultList":{
            "$ref":"#/components/schemas/DiscrepancyResultList"
        },
        "errorList":{
            "$ref":"#/components/schemas/DiscrepancyIssueErrorList"
        }
    },
    "xml":{
        "name":"IssueResponseIssueResult",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyIssueErrorList

Type: object

Show Source

• discrepancyIssueError(required): array DiscrepancyIssueError

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

Nested Schema : DiscrepancyResultList

Type: object

Show Source

• discrepancyResult(required): array DiscrepancyResult

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

Nested Schema : DiscrepancyIssueError

Type: array

Show Source

• Array of: object DiscrepancyIssueError

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

Nested Schema : DiscrepancyIssueError

Type: object

Show Source

• discrepancyIssueRequest(required): object DiscrepancyIssueRequest
• message(required): string
• messageId(required): string

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

Nested Schema : DiscrepancyIssueRequest

Type: object

Show Source

• inFormItemIdentifier(required): object InFormItemIdentifier
• initialState(required): string
  Allowed Values: [ "CANDIDATE", "OPENED" ]
• reason(required): string

{
    "required":[
        "inFormItemIdentifier",
        "initialState",
        "reason"
    ],
    "type":"object",
    "properties":{
        "inFormItemIdentifier":{
            "$ref":"#/components/schemas/InFormItemIdentifier"
        },
        "initialState":{
            "type":"string",
            "xml":{
                "name":"InitialState"
            },
            "enum":[
                "CANDIDATE",
                "OPENED"
            ]
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        }
    }
}

Nested Schema : InFormItemIdentifier

Type: object

Show Source

• inFormItem: object InFormItem
• inFormItemDbuid: string
• inFormItemGuid: string

{
    "type":"object",
    "properties":{
        "inFormItem":{
            "$ref":"#/components/schemas/InFormItem"
        },
        "inFormItemGuid":{
            "type":"string",
            "xml":{
                "name":"InFormItemGuid"
            }
        },
        "inFormItemDbuid":{
            "type":"string",
            "xml":{
                "name":"InFormItemDbuid"
            }
        }
    }
}

Nested Schema : InFormItem

Type: object

Show Source

• form: object RefNameTuple
• itemName: string
• itemSet: object ItemSet
• sectionName: string
• siteId: integer (int64)
• subjectGuid: string
• visit: object RefNameTuple

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"SiteId"
            }
        },
        "subjectGuid":{
            "type":"string",
            "xml":{
                "name":"SubjectGuid"
            }
        },
        "visit":{
            "$ref":"#/components/schemas/RefNameTuple"
        },
        "form":{
            "$ref":"#/components/schemas/RefNameTuple"
        },
        "sectionName":{
            "type":"string",
            "xml":{
                "name":"SectionName"
            }
        },
        "itemSet":{
            "$ref":"#/components/schemas/ItemSet"
        },
        "itemName":{
            "type":"string",
            "xml":{
                "name":"ItemName"
            }
        }
    }
}

Nested Schema : RefNameTuple

Type: object

Show Source

• index: number (double)
• name(required): string
• revision: number (double)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"Name"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "index":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Index"
            }
        }
    }
}

Nested Schema : ItemSet

Type: object

Show Source

• name(required): string
• order: number (double)
• revision: number (double)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"Name"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "order":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Order"
            }
        }
    }
}

Nested Schema : DiscrepancyResult

Type: array

Show Source

• Array of: object DiscrepancyResult

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

Nested Schema : DiscrepancyResult

Type: object

Show Source

• discrepancy(required): object DiscrepancyInstance
• inFormItemIdentifier(required): object InFormItemIdentifier
• mappedItem: boolean

{
    "required":[
        "discrepancy",
        "inFormItemIdentifier"
    ],
    "type":"object",
    "properties":{
        "discrepancy":{
            "$ref":"#/components/schemas/DiscrepancyInstance"
        },
        "inFormItemIdentifier":{
            "$ref":"#/components/schemas/InFormItemIdentifier"
        },
        "mappedItem":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

Nested Schema : DiscrepancyInstance

Type: object

Show Source

• dateEntered: string (date-time)
• guid(required): string
• inFormItem: object InFormItem
• reason: string
• reissued: boolean
• revision(required): number (double)
• state: string
  Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]
• type: string
  Allowed Values: [ "AUTO", "MANUAL", "UNSPECIFIED" ]
• userName: string

{
    "required":[
        "guid",
        "revision"
    ],
    "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"
            ]
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"Type"
            },
            "enum":[
                "AUTO",
                "MANUAL",
                "UNSPECIFIED"
            ]
        },
        "reissued":{
            "type":"boolean",
            "xml":{
                "name":"Reissued"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        },
        "dateEntered":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"DateEntered"
            }
        },
        "userName":{
            "type":"string",
            "xml":{
                "name":"UserName"
            }
        },
        "inFormItem":{
            "$ref":"#/components/schemas/InFormItem"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : IssueResponseIssueResult

Type: object

Show Source

• errorList: object DiscrepancyIssueErrorList
• resultList(required): object DiscrepancyResultList

{
    "required":[
        "resultList"
    ],
    "type":"object",
    "properties":{
        "resultList":{
            "$ref":"#/components/schemas/DiscrepancyResultList"
        },
        "errorList":{
            "$ref":"#/components/schemas/DiscrepancyIssueErrorList"
        }
    },
    "xml":{
        "name":"IssueResponseIssueResult",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyIssueErrorList

Type: object

Show Source

• discrepancyIssueError(required): array DiscrepancyIssueError

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

Nested Schema : DiscrepancyResultList

Type: object

Show Source

• discrepancyResult(required): array DiscrepancyResult

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

Nested Schema : DiscrepancyIssueError

Type: array

Show Source

• Array of: object DiscrepancyIssueError

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

Nested Schema : DiscrepancyIssueError

Type: object

Show Source

• discrepancyIssueRequest(required): object DiscrepancyIssueRequest
• message(required): string
• messageId(required): string

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

Nested Schema : DiscrepancyIssueRequest

Type: object

Show Source

• inFormItemIdentifier(required): object InFormItemIdentifier
• initialState(required): string
  Allowed Values: [ "CANDIDATE", "OPENED" ]
• reason(required): string

{
    "required":[
        "inFormItemIdentifier",
        "initialState",
        "reason"
    ],
    "type":"object",
    "properties":{
        "inFormItemIdentifier":{
            "$ref":"#/components/schemas/InFormItemIdentifier"
        },
        "initialState":{
            "type":"string",
            "xml":{
                "name":"InitialState"
            },
            "enum":[
                "CANDIDATE",
                "OPENED"
            ]
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        }
    }
}

Nested Schema : InFormItemIdentifier

Type: object

Show Source

• inFormItem: object InFormItem
• inFormItemDbuid: string
• inFormItemGuid: string

{
    "type":"object",
    "properties":{
        "inFormItem":{
            "$ref":"#/components/schemas/InFormItem"
        },
        "inFormItemGuid":{
            "type":"string",
            "xml":{
                "name":"InFormItemGuid"
            }
        },
        "inFormItemDbuid":{
            "type":"string",
            "xml":{
                "name":"InFormItemDbuid"
            }
        }
    }
}

Nested Schema : InFormItem

Type: object

Show Source

• form: object RefNameTuple
• itemName: string
• itemSet: object ItemSet
• sectionName: string
• siteId: integer (int64)
• subjectGuid: string
• visit: object RefNameTuple

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"SiteId"
            }
        },
        "subjectGuid":{
            "type":"string",
            "xml":{
                "name":"SubjectGuid"
            }
        },
        "visit":{
            "$ref":"#/components/schemas/RefNameTuple"
        },
        "form":{
            "$ref":"#/components/schemas/RefNameTuple"
        },
        "sectionName":{
            "type":"string",
            "xml":{
                "name":"SectionName"
            }
        },
        "itemSet":{
            "$ref":"#/components/schemas/ItemSet"
        },
        "itemName":{
            "type":"string",
            "xml":{
                "name":"ItemName"
            }
        }
    }
}

Nested Schema : RefNameTuple

Type: object

Show Source

• index: number (double)
• name(required): string
• revision: number (double)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"Name"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "index":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Index"
            }
        }
    }
}

Nested Schema : ItemSet

Type: object

Show Source

• name(required): string
• order: number (double)
• revision: number (double)

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"Name"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "order":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Order"
            }
        }
    }
}

Nested Schema : DiscrepancyResult

Type: array

Show Source

• Array of: object DiscrepancyResult

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

Nested Schema : DiscrepancyResult

Type: object

Show Source

• discrepancy(required): object DiscrepancyInstance
• inFormItemIdentifier(required): object InFormItemIdentifier
• mappedItem: boolean

{
    "required":[
        "discrepancy",
        "inFormItemIdentifier"
    ],
    "type":"object",
    "properties":{
        "discrepancy":{
            "$ref":"#/components/schemas/DiscrepancyInstance"
        },
        "inFormItemIdentifier":{
            "$ref":"#/components/schemas/InFormItemIdentifier"
        },
        "mappedItem":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

Nested Schema : DiscrepancyInstance

Type: object

Show Source

• dateEntered: string (date-time)
• guid(required): string
• inFormItem: object InFormItem
• reason: string
• reissued: boolean
• revision(required): number (double)
• state: string
  Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]
• type: string
  Allowed Values: [ "AUTO", "MANUAL", "UNSPECIFIED" ]
• userName: string

{
    "required":[
        "guid",
        "revision"
    ],
    "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"
            ]
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"Type"
            },
            "enum":[
                "AUTO",
                "MANUAL",
                "UNSPECIFIED"
            ]
        },
        "reissued":{
            "type":"boolean",
            "xml":{
                "name":"Reissued"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        },
        "dateEntered":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"DateEntered"
            }
        },
        "userName":{
            "type":"string",
            "xml":{
                "name":"UserName"
            }
        },
        "inFormItem":{
            "$ref":"#/components/schemas/InFormItem"
        }
    }
}

Back to Top