Advanced

Request URLUniform Resource Locator is the address of a web page on the world wide web. Type
  • Standard:

    http://example.domain.com/api/index.php?/App/Controller/Action¶meter=1&...

  • With an ?e= parameter:

    http://example.domain.com/api/index.php?e=/App/Controller/Action¶meter=1&...

Some customers on certain types of web server run into problems using one, but not the other (often relating to rewrite rules or security packages).

Arrays

To post an array using the query string, you should list each item in the array like this:

?usergroupid[]=2&usergroupid[]=3&usergroupid[]=X

The above example essentially passes an array to your helpdesk containing ("2", "3", "X") for the parameter usergroupid.

Response

The server's response to a REST API request is always an HTTPHypertext Transfer Protocol - A protocol for exchange of hypertext documents in HTML. response with a status code representing the result of the request.

Some responses contains a payload in the body and others don't.

Response code Description
200 OK The request was processed successfully.
400 Bad Request The request cannot be fulfilled due to bad syntax.
401 Unauthorized Similar to 403 Forbidden, but specifically for use when authentication is possible but has failed or not yet been provided.
403 Forbidden The request was a legal request, but the server is refusing to respond to it.
404 Not Found The requested resource could not be found but may be available again in the future.
405 Not Allowed A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.