usr: HTTP x-msg-usr entity-header

Set or return the user properties.

Type Description
HTTP header name x-msg-usr
HTTP header type Entity-header
Valid in HTTP request message POST, x-msg-require-headers
Allowed values See Syntax ; for example,

x-msg-usr: myProp1;5;i1,
x-msg-usr: myProp2;"My String";string
Default value Not applicable

Description

  • When set on an HTTP POST request, set the request message user properties.
  • On an HTTP GET or DELETE request, the x-msg-usr header is ignored.
  • Specified in x-msg-require-headers, sets x-msg-usr in the HTTP response message to user properties of a message.
  • Multiple properties can be set on a message. Specify multiple comma-separated properties in a single x-msg-usr header, or by using two or more separate instances of the x-msg-usr header.
  • You can request a specific property to be returned in the response to a GET or DELETE request. Specify the name of the property in the x-msg-require-headers header of the request, using the prefix usr-. For example,
    
    x-msg-require-headers: usr-myProp1
    
  • To request that all user properties are returned in a response, use the ALL-USR constant. For example,
    
    x-msg-require-headers: ALL-USR
    

Syntax

Read syntax diagramSkip visual syntax diagram x-msg-usr: ,usr-property-value
usr-property-value
Read syntax diagramSkip visual syntax diagram property-name ; usr-value ; usr-type
property-name
Read syntax diagramSkip visual syntax diagram string
usr-value
Read syntax diagramSkip visual syntax diagrambooleani1i2i4i8r4r8qstring
usr-type
Read syntax diagramSkip visual syntax diagrambooleani1i2i4i8r4r8string
boolean
Read syntax diagramSkip visual syntax diagramTRUEFALSE
i1
Read syntax diagramSkip visual syntax diagram -128   ≤ n  ≤ +127
i2
Read syntax diagramSkip visual syntax diagram -32768   ≤ n  ≤ +32767
i4
Read syntax diagramSkip visual syntax diagram -2147483648   ≤ n  ≤ +2147483647
i8
Read syntax diagramSkip visual syntax diagram -9223372036854775808   ≤ n  ≤ +92233720368547750807
r4
Read syntax diagramSkip visual syntax diagram -1.4E-45   ≤ n  ≤ +3.4028235E38
r8
Read syntax diagramSkip visual syntax diagram -4.9E-324   ≤ n  ≤ +1.7976931348623157E308
qstring
Read syntax diagramSkip visual syntax diagram " string "