Status Confirmation (SearchConfirm)
Approval of the Listed Statuses
To prevent statuses listed via Rooster APIs from being displayed in a query, the statuses must be confirmed. The SearchConfirm() method is used for this service.
- opType must specify the operation type. The operation type is defined by an Enum variable and only allowed values are accepted. This field is mandatory.
- opCode must specify the operation code. This field is mandatory.
POST SearchConfirm
Use
Parameter Descriptions & Rules
The following table lists the input and output parameters of the SearchConfirm() operation and the
types and formats of these parameters.
- Request Fields
- Response Fields
- Example Request
- Example Response
| Parameter | Mandatory | Description | Data Type |
|---|---|---|---|
processKey | Yes | Information provided to you for processKey | string |
opCode | Yes | Operation Code | string |
opType | Yes | Operation Type | string |
opType
| Parameter | Description |
|---|---|
Order | Orders Status |
Receipt | Receipt Status |
Return | Return Status |
Transfer | Transfer Status |
| Parameter | Description | Data Type |
|---|---|---|
result | Transaction status (0-Successful / 1-Failed) | string |
errorCode | Error Message | string |
systemMessage | System Message | string |
{
"processKey": "A1389BF5246943ED8F40DEF725E0EE84",
"opCode": "ORDLOREM",
"opType": "Order"
}
{
"result": "0",
"errorCode": "",
"systemMessage": ""
}
Service Responses
| result | errorCode | systemMessage | Description |
|---|---|---|---|
| 0 | The status was successfully approved. | ||
| 1 | 101 | A mistake has occurred! | Error messages are displayed in status displays. |