REST/SOAP endpoints

Learn how to create REST and SOAP endpoints.

Each project require at least one endpoint. However, you can create as many endpoints as required.

Any created endpoint is reachable with or without a trailing slash. For example, if your published endpoint is .../foo, then it is also reachable by .../foo/.

HTTP methods

The following table describes the supported HTTP Methods.

Method

Description

GET

Request to retrieve data (resource).

POST

Request to create a new resource using data provided in the body of the request.

PUT

Request to update (or completely replace) an existing resource using the data you want to change.

PATCH

Request to modify an existing resource using the data you want to change.

DELETE

Request to delete the resource.

Endpoint path

The following shows the structure of an endpoint path in Xapix.

<organization-name>/<project-name>/<resource>/<subresource>/{parameter}

Path element

Description

<organization-name>

Organization in which you created the project that contains the endpoint.

<project-name>

Project containing the endpoint.

<resource>

Top level exposed resource.

<subresource>

Subsequent level exposed resource.

{parameter}

Path parameter within curly braces { }.

‚Äč