Slim CD’s web services contain multiple functions called Entry Points. Slim CD’s implementation of web-based services follows a pattern where the web service name is further qualified by a specific function name.

For example:

Each entry point accepts a request and returns a reply. Each data format will be different but the contents will be the same. Each entry point has a Definitions tab that shows all of the fields acceptable for input and that are returned for output.

Definitions Tab Features

Business Rules

Any applicable business logic to consider, such as “Duplicate Checking” on payment transactions.

REQUEST fields

Request data is formatted differently depending on the desired input/output. The most common choice is NAME/VALUE pairs. When sending data in NAME/VALUE pairs, you must URL-Encode the individual data values.

REPLY fields

Reply data is typically returned in XML. Some services return JSON. There are specific entry points that return name/value pairs or CSV-style formatted data.
Reply data has a hierarchy that starts with the standard SLIM CD header, containing the results of calling the web service and a description in case of an error or failure.

Remarks

Each entry point may have a “Remarks” section. Pay close attention to this section, as it may contain important caveats, exceptions and notes. For example, some specific entry points return different content-types (images or text receipts). Those entry points will use HTTP status codes to identify success or failure. You will see this noted in the Remarks section.
Each Entry Point will format the REPLY block according to the standards established for that given technology. For example, web services will return XML or JSON while libraries will return objects whereby the name of the entry point will have a suffix of “Request” or “Reply”