Skip to content
Advertisement

What is a “Payload”? e.g XML Payload

While browsing some web service docs, I came across the word “payload“, “xml payload” …

enter image description here


enter image description here


enter image description here


From wikipedia: “*Payload in computing (sometimes referred to as the actual or body data) is the cargo of a data transmission. *”

Does not make much sense here. Can anyone explain what payload / xml payload mean? Thanks.

Advertisement

Answer

The “payload” is the actual contents, as opposed to the wrapper, which is the boilerplate XML around (meta-data, document type and such). As such, it is the variable part of the reply.

The wikipedia definition makes perfect sense to me, as the “non payload” XML in these examples is completely uninteresting. The XML outside is the wrapping, and the payload are the contents (“cargo”).

Note that “escaped payload” indicates that the contents are actually some other format, which may be XML escaped. It could be binary data, often escaped as CDATA or Base64, for example. There could be a JPEG image there, for example (if it is correctly escaped). Or HTML, encoded with XML entities. Then the payload would for example be:

<div>example</div>

Which is a simple example for XML-escaped-HTML payload, when there is no reason for the message XML parser to parse the (XML-like) payload.

User contributions licensed under: CC BY-SA
7 People found this is helpful
Advertisement