Special Characters

Using special characters in resource ID's

There are special characters in Accela business entity IDs which conflict with reserved URL characters. Escape the special characters to work with Construct APIs as resource IDs. For example, the following Civic Platform record type ID:

ServiceRequest-Streets and Sidewalks-Snow Removal-NA

is encoded as:

ServiceRequest.1Streets.cand.cSidewalks-Snow.cRemoval.1NA

Construct APIs typically encode the record type IDs in responses before returning them as resource IDs.

Characters Escaped Characters
. .0
- .1
% .2
/ .3
\\ .4
: .5
* .6
\ .7
< .8
> .9
| .a
? .b
space .c
& .d
# .e

Using special characters in request payloads

A JSON request body used with a create (HTTP POST) or update (HTTP PUT) API may contain special characters. Construct API supports JSON request payloads containing the following special characters:

' = - _ : ~
! @ # $ % ^
& * ( ) { }
[ ] | / . ,
< > ; ` ?

The following special characters must be escaped with the backslash character in request payloads:

Special Character Escaped character in request payload
" \"
Tab \t
New line \n
Carriage return (Enter key) \r
\ \\