PreviousNextUp[Front page] [Index]

Reply Messages

DTD definition for ReplyMessages XML document structure:

<!--                                                        -->
<!-- ProviderID    - currently not used                     -->
<!ELEMENT ProviderID       (#PCDATA) >
<!--                                                        -->
<!-- MessageID                                              -->
<!ELEMENT MessageID        (#PCDATA) >
<!--                                                        -->
<!-- ObjectID      - certifier internal object id           -->
<!ELEMENT ObjectID         (#PCDATA) >
<!--                                                        -->
<!-- Operation     - add, update, delete, disable,          -->
<!--                 enable, revoke                         -->
<!ELEMENT Operation        (#PCDATA) >
<!--                                                        -->
<!-- Status        - ok, error                              -->
<!ELEMENT Status           (#PCDATA) >
<!--                                                        -->
<!-- Name          - entity name in certifier format        -->
<!ELEMENT Name             (#PCDATA) >
<!--                                                        -->
<!-- Error         - error message                          -->
<!ELEMENT Error            (#PCDATA) >
<!--                                                        -->
<!-- PSK           - psk info. all valid psk's are reported -->
<!ELEMENT PSK              (#PCDATA) >
<!ATTLIST PSK              refNum  CDATA #REQUIRED >
<!--                                                        -->
<!-- Parameter     - contains all attributes from           -->
<!--                 the related notification message       -->
<!ELEMENT Parameter        EMPTY >
<!ATTLIST Parameter        attrName  CDATA #REQUIRED
                               attrValue CDATA #REQUIRED >
<!ELEMENT ReplyParameters  (Parameter)* >
<!ELEMENT Message          (ProviderID, 
                                Operation,
                                Status,
                                Name,
                                MessageID,
                                ObjectID,
                                PSK,
                                Error,
                                ReplyParameters) >
<!ELEMENT ReplyMessages    (Message)* >
<!--                                                        -->

An example of an XML reply message is shown below:

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE ReplyMessages SYSTEM "ext_id_reply_msg_dtd.dtd">
<!--                                                     -->
<ReplyMessages>
 <Message>
  <ProviderID>12345</ProviderID>
  <MessageID>msg123</MessageID>
  <Operation>update</Operation>
  <ObjectID>435342</ObjectID>
  <ReplyParameters>
    <Parameter attrName="Email" attrValue="test.user@test.com"/>
    <Parameter attrName="PskReferenceNumber" attrValue="65432"/>
    <Parameter attrName="PskKey" attrValue="secret key"/>
  </ReplyParameters>
 </Message>
 <Message>
  <ProviderID>12345</ProviderID>
  <MessageID>Z1</MessageID>
  <Operation>add</Operation>
  <ObjectID>238324</ObjectID>
  <PSK refNum="16434">CznG-Y7xu-gpuD-Zbk6</PSK>
  <EntityParameters>
    <Parameter attrName="UserName" attrValue="Test User E 31"/>
    <Parameter attrName="UserCertificate" attrValue="
      -----BEGIN CERTIFICATE-----
      MIIB8TCCAVqgAwIBAgICeIYwDQYJKoZIhvcNAQEFBQAwEjEQMA4GA1UEAxMH
      VGVzdCBDQTAeFw0wNDA1MDMwNTEzMTRaFw0wNDA2MDIwNTQzMTRaMBkxFzAV
      BgNVBAMTDlRlc3QgVXNlciBFIDMxMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
      iQKBgQC4hnEpXnOOXUHmjnvnsy950HiqBIb9b5zlBhxO26jEPz9BKjPR9653
      8i3cDYEGjw9xGkQ1eZkY2yLECsceDJeG7bpavMUEKovhCUiEQxnDaPrJ1GU5
      dXMexNEYIJhK+igKNWadH8VLf+7dL62flQaL0ePkDi8RNut+2+E/kTh7DwID
      AQABo08wTTAfBgNVHSMEGDAWgBQsKkKawhZLsT/Oce9jg05j+2OrwjAdBgNV
      HQ4EFgQU9LQdcHbBlifyVmbMtkq27kYa2XowCwYDVR0PBAQDAgSwMA0GCSqG
      SIb3DQEBBQUAA4GBAAogdJ5Xmz8COl2P1IcrtEDD08pn9TWB6gnyz9MAunhV
      jnAQ9kLri4+5KHVzCsYjyo6AIrXCeslW12x9ID9RperTcT28g0FN+5SgDwyY
      IiE1TyasCPc7s4op3RqJEdImbFWu5bWTiwVeH1slSRSnt43hrdGLtS7cMkww
      eeOPlKfC
      -----END CERTIFICATE----- "/>
  </EntityParameters>
 </Message>
 <Message>
  <ProviderID>12345</ProviderID>
  <MessageID>Z2</MessageID>
  <Operation>add</Operation>
  <Status>error</Status>
  <Error>failed to add entity</Error>
 </Message>
</ReplyMessages>


PreviousNextUp[Front page] [Index]