ServiceResponse

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  ServiceResponse
Response envelope for error messages and status message returned by actions that generate no content.
Available Fields:
code
Type: String(3)
XML Representation: attribute
Attributes:
Default Value OK1
Response code that can be used to classify the type of response received.
httpStatusCode
Type: Integer
XML Representation: attribute
Attributes:
Default Value
When http suppress mode is enabled, the field contains the http status code associated with the underlying server response.
detailMessage
Type: String(1024)
XML Representation: attribute
Attributes:
Default Value
Response message that provides additional details (when appropriate) needed to understand this specific response (e.g. for validation errors this would indicate which field is invalid). Detail message may be shown to the end user if appropriate.

XML Sample:

<service response code="OK1"  httpStatusCode="200"  detailMessage="OK" />
"<service response code=\"OK1\" httpStatusCode=\"200\" detailMessage=\"OK\" />"

JSON Sample:

{
  "code": "OK1",
  "httpStatusCode": "200",
  "detailMessage": "OK"
}

XURL Sample:

?code=OK1&httpStatusCode=200&detailMessage=OK&
code=OK1
httpStatusCode=200
detailMessage=OK
Copyright © Constellation Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.