JSON Encoding

The JSON Encoding feature allows the user to view or modify the setting for JSON responses.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Set strict JSON encoding format for API-return data-types
POST
/v1/{practiceid}/misc/properjsonencoding

Configures the setting determining whether or not JSON responses are properly encoded for Booleans, integers, and strings

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns true if operation was a success.
Example Code
Get the current status for strict-JSON encoding format setting
GET
/v1/{practiceid}/misc/properjsonencoding

Retrieves the configured setting whether or not JSON responses are properly encoded for Booleans, integers, and strings

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
useproperjsontypesyn string If true, will return booleans as JSON true/false and integers as type ints for fields that have been marked as such types.
Example Code
Disables setting strict JSON encoding format for API-return data-types
DELETE
/v1/{practiceid}/misc/properjsonencoding

Disables the setting determining JSON responses

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
success string Returns true if operation was a success.
Example Code