Skip to content

3 Running

Fabio Filardi edited this page May 23, 2017 · 5 revisions

Service endpoints

There are two controllers available on this sample project. For the UserSession controller, there are only one endpoint to be called using GET action:

https://<your-webapp-url:port>/user

GET https://localhost:44300/user

For Expense controller, there are a few more options using different actions (GET, PUT, DELETE, POST).

https://<your-webapp-url:port>/expense/
https://<your-webapp-url:port>/expense/{id}
https://<your-webapp-url:port>/expense/{id}/submit

GET https://localhost:44300/expense/000023

Company specific data

When calling an endpoint that retrieves company specific data, the default company setup for the current user is used. To select another company you should include the query parameter company=<id> in the URL. This works automatically for any operation on any available resource.

GET https://localhost:44300/customers?company=USRT

Note: When calling from a browser you may want to force the results to be displayed as XML or JSON. This is possible using the parameter type in the URL, adding type=JSON or type=XML.

GET https://localhost:44300/user?type=JSON

For detailed information check Swagger real-time documentation below.

Real-time documentation

AxaptaAPI uses Swagger for interactive documentation and client SDK generation. To access it just open the address:

https://<your-webapp-url:port>/swagger

Swagger

It's possible to verify the endpoints, response schema, parameters and try it any of the endpoint specifying your own parameters/body.

Clone this wiki locally