2.2.2.11 payload Element

  • Article

The payload element specifies any SQM session data payload in the POST body following the XML message (see Figure 2). A payload element without child arg elements MAY be included when there is no SQM binary data in the POST body.

The payload element schema is specified in [MS-TPXS] section 2.1.1.1.2.1. The payload element is the parent element of a set of child arg elements describing the payload length and compression (if any). The payload element is required and MUST include the following arg elements if the client request includes the request command dataupload as specified in section 2.2.2.16.2.

payload arg element:

  • nm attribute: size

  • val attribute: A 64-bit decimal number specifying the length of the binary SQM payload in bytes.

The payload element is required and MUST include the following arg elements if the SQM session binary data is compressed. If the SQM session binary data is not compressed, then the client MUST NOT include the following arguments.

payload arg element:

  • nm attribute: comp

  • val attribute: A value specifying compression type.<35>

payload arg element:

  • nm attribute: precompsize

  • val attribute: A 64-bit decimal number specifying the length of the binary data before compression.

Additional arg elements MAY be specified and are dependent upon the client and server implementation. Unrecognized arg key-value pairs are ignored by the server.