Search
K
MarketConnect-OrderEntry

Returns a simple health status indicating the API process is running.

Returns a simple health status. No authentication required.

get

Response

200

API is healthy

get/market-connect/order-entry/v1/health
 
200

AdditionalDocumentType

object
* Additional properties are NOT allowed.
attachmentTypearray[string]

List of attachment type codes

documentTypearray[string]

List of document type codes

formTypearray[string]

List of form type codes

Example

AttachmentData

object
* Additional properties are NOT allowed.
additionalDocumentTypesarray[object]

List of additional document types that can be uploaded

* Additional properties are NOT allowed.
Show Child Parameters
documentRulesarray[object]

Conditional rules that determine required or optional documents

* Additional properties are NOT allowed.
Show Child Parameters
documentsarray[object]

Documents already uploaded for the transaction

* Additional properties are NOT allowed.
Show Child Parameters
requiredDocumentsarray[object]

Documents that are required for submission

* Additional properties are NOT allowed.
Show Child Parameters
Example

AttachmentDocument

object
* Additional properties are NOT allowed.
attachmentTypestring

Attachment type code

documentTypestring

Document type code

fileNamestring

Uploaded file name

formTypestring

Form type code

uploadDatestring

Upload date of the document

Example

AttachmentResponse

object
* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the transaction the attachment belongs to

>= 1 characters

caseIdstring

Case identifier associated with the transaction

dataobjectrequired

Attachment data containing documents, required documents and rules

* Additional properties are NOT allowed.
Show Child Parameters
Example