XML-based Interface

The XML Data server uses an XML based protocol, in which a client communicates with the XML Data server by issuing request message strings over an underlying TCP/IP network connection. A session consists of a series of XML commands, initiated by the client, and responses from the XML Data server.

Every XML request/response consists of a 4-byte binary length value, followed by the indicated number of ASCII characters that form the XML request. There is no need to terminate the XML request with any terminating character(s).

The length value is a 4 byte integer in network byte order indicating the size in bytes of the XML part.

Note: “Network byte order” refers to the standard byte order defined in the IP protocol. It corresponds to big-endian (most significant first). It is a zero-padded 4 byte value.

The following data-stream Hex dump provides an example of an update subscriber request sent from an XML Data server client to the XML Data server.

00000000  00 00 00 8d 3c 75 70 64  61 74 65 53 75 62 73 63  ....<updateSubsc
00000010  72 69 62 65 72 20 65 6e  74 3d 22 73 75 62 73 63  riber ent="subsc
00000020  72 69 62 65 72 52 6f 75  74 69 6e 67 22 20 6e 73  riberRouting" ns
00000030  3d 22 64 73 72 22 3e 3c  69 6d 73 69 3e 33 31 30  ="dsr"><imsi>310
00000040  39 31 30 34 32 31 30 30  30 30 31 30 33 3c 2f 69  9104210000103</i
00000050  6d 73 69 3e 3c 6c 74 65  68 73 73 3e 4c 54 45 5f  msi><ltehss>LTE_
00000060  48 53 53 5f 32 3c 2f 6c  74 65 68 73 73 3e 3c 61  HSS_2</ltehss><a
00000070  61 61 3e 41 41 41 5f 34  3c 2f 61 61 61 3e 3c 2f  aa>AAA_4</aaa></
00000080  75 70 64 61 74 65 53 75  62 73 63 72 69 62 65 72  updateSubscriber00000090  3e

Like the XML request message, an XML response message consists of a 4 byte binary length value, followed by the indicated number of ASCII characters that form the XML response. There is no terminator to the XML response.

The following data-stream Hex dump provides an example of an update subscriber response message string sent from an XML Data server client to the XML Data server client.

00000000  00 00 00 4a 3c 75 70 64  61 74 65 53 75 62 73 63  ....<updateSubsc
00000010  72 69 62 65 72 52 65 73  70 3e 3c 72 65 73 20 65  riberResp><res e
00000020  72 72 6f 72 3d 22 30 22  20 61 66 66 65 63 74 65  rror="0" affecte
00000030  64 3d 22 31 22 2f 3e 3c  2f 75 70 64 61 74 65 53  d="1"/></updateS
00000040  75 62 73 63 72 69 62 65  72 52 65 73 70 3e        ubscriberResp>