Get Key Mapping Response
The response specification is as follows:
The response message contains the following header properties:
| Element | Type | Cardinality | Description |
| businessTransactionID | String | Optional | The unique identifier for tracing across function calls. This is used for logging. |
| correlationID | String | Optional | The unique identifier for tracing purposes across a single function call. This is generally used by the calling application to correlate requests and responses. |
| success | Boolean | Required | The flag indicating if the call was successful. |
| messageCode | String | Required | The result message code. |
| message | String | Required | The result message. |
| orderID | String | Required | The internal unique identifier for the order. |
| orderRef | String | Required | The external unique identifier for the order. |
| planID | String | Required | The internal unique identifier for the plan for the order if it exists. |
The response message contains the XML payload according to the following schema:
The following table lists the details of the elements.
| Element | Type | Cardinality | Description |
| businessTransactionID | String | Optional | The unique identifier for tracing across function calls. This is used for logging. |
| resultStatus | Type | Required | The result status type. See Appendix A for the specification of this type. |
| orderID | String | Required | The internal unique identifier for the order. |
| orderRef | String | Required | The external unique identifier for the order. |
| planID | String | Required | The internal unique identifier for the plan for the order if it exists. |
Copyright © 2023. Cloud Software Group, Inc. All Rights Reserved.
