Reserved Characters and Escape Values

Use the following characters in URLs only in syntactically required locations. To use in argument values, they must be escaped.

Reserved character Escape value

slash (/)

%2F

question mark (?)

%3F

ampersand (&)

%26

semicolon (;)

%3B

colon (:)

%3A

commercial at sign (@)

%40

comma (,)

%2C

dollar sign ($)

%24

equals sign (=)

%3D

space ( )

%20

percent sign (%)

%25

quotation marks (")

%22

plus sign (+)

%2B

hash (#)

%23

asterisk (*)

%2A

less-than sign (<)

%3C

greater-than sign (>)

%3E

left brace ({)

%7B

right brace (})

%7D

vertical bar (|)

%7C

left square bracket ([)

%5B

right square bracket (])

%5D

circumflex (^)

%5E

backslash (\)

%5C

accent grave (`)

%60

left parenthesis (() %28
right parenthesis ()) %29

If a URL contains invalid characters, BOSS API returns a Bad Request response with a status code of 400.

Important

Some of the BOSS API examples in this document contain reserved characters that need to be escaped. However, for legibility the examples eliminate the escape values. Therefore, if you use these examples verbatim to test queries, they will not work.

Table of Contents