Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 2021.3

...

Excerpt

To retrieve LIST values from the API send a request structured as below:

Code Block
languagexml
https://url/endpoint.json?LIST=VALUE

The List Call is used to locate the proper List RECID value that needs to be passed in the endpoint call

All List Types will be returned from the Endpoint the request was sent to. TheĀ format The format is different depending on the LIST requested , but should look similar to the example below.

Code Block
languagexml
{
    "status": "success",
    "page": 1,
    "count": 11,
    "total_count": 3,
    "sd_action": [
        {
            "RECID": 237,
            "VALUE": "Add"
        },
        {
            "RECID": 238,
            "VALUE": "Change Types"
        },
        {
            "RECID": 239,
            "VALUE": "Add Locations"
        }
    ]
}


...

Insert excerpt
HTML Appendix
HTML Appendix
nopaneltrue

Insert excerpt
SQL API Calls
SQL API Calls
nopaneltrue


Failed Inserts / Updates

Business logic and database integrity checks are enforced when inserting or updating data. If the required data is missing or incorrect, an error will be returned with a status of "failure" and a description of the failure. Possible failures include missing required data, incorrect or missing foreign keys, non-compliance to application business rules or logic, and Custom Validation rules.

...