Product Documentation

The following example defines the CCReturnObject type. A line-by-line explanation follows.

#

XML Content

1

<xs:complexType name="CCReturnObject">

2

<xs:sequence>

3

<xs:element name="did" type="xs:long" minOccurs="0"/>

4

<xs:element name="messagekey" type="xs:string" minOccurs="0"/>

5

<xs:element name="message" type="xs:string" minOccurs="0"/>

6

<xs:element name="objectContent" type="xs:anyType" minOccurs="0"/>

7

<xs:element name="objectType" type="xs:int" minOccurs="0"/>

8

<xs:element name="srid" type="xs:long" minOccurs="0"/>

9

</xs:sequence>

10

</xs:complexType>

#

XML Content Explanation

1

The start of the CCReturnObject element.

2

The start of a sequence.

3

The DID element—the identifier of the encryption domain that serviced this request.

4

The messagekey element—a message code used by the appliance as a reference. Messages of the format 'SKL-MSG-NNNN' indication a success and message of the format 'SKL-ERR-NNNN' indication failures (where NNNN are numerals).

5

The message element—a message which describes a success or a failure condition.

6

The objectContent element—a JSON or XML that contains the result of a successful web service operation. A JSON will be returned by default unless the encryption domain's or SAKA's strongkeylite.cfg.property.ccsresponseformat property is overwritten on the server.

7

The objectType element—an integer value identifying the kind of object returned.

  • 1 = CC_DATA

  • 2 = CC_DIGEST

  • 3 = CC_ENCRYPTED_OBJECT

  • 4 = CC_ENCRYPTED_SYMMETRIC_KEY

  • 5 = CC_ENCRYPTED_SYMMETRIC_KEYS

  • 6 = TOKEN

  • 7 = DECRYPTED_XML

  • 8 = REENCRYPTED_PIN

  • 9 = KEY_CHECK_VALUE

  • 10 = MAC_REQUEST

  • 11 = MAC_RESPONSE

8

The srid element—a unique request identifier for this transaction.

9

The end of the sequence.

10

The end of the CCReturnObject.