> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/web-services-framework/web-services-framework-overview.md).

# Web Services Framework Overview

## What is the Web Services Framework?

The Web Services Framework is an easy-to-use framework for building a web service application in LogicNets. It helps you build simple web services and more complicated ones like RESTful API.

The framework performs I/O handling and JSON and simple XML automatic conversion. It also allows you to override data conversion with custom conversion and implement multiple end points in a single web service application. You can easily test from the Designer.

## Web Services URLs

The URL of your web service is composed of the following three parts: the host name, the start code, and the endpoint:

**https\:////**

For a project with a start code of *demostart* and an endpoint called *endpoint\_net* the URL would be [https://logicnets-demo.com/demostart/endpoint\_net](https://support.logicnets.com/kc/%3Ch1%3EWhat%20is%20the WebServices framework?%3C/h1%3E%20%3Cp%3EEasy%20to%20use%20framework%20for%20building%20a%20webservice%20application%20in LogicNets %3C/p%3E%20%3Cp%3EFrom%20simple%20webservices%20to%20RESTful%20API%3C/p%3E%20%3Cp%3ETakes%20care%20of%20I/O%20handling%3C/p%3E%20%3Cul%3E%20%3Cli%3EOut-of-box:%20JSON,%20simple%20XML:%20automatic%20conversion%3C/li%3E%20%3Cli%3EIf%20needed%20data%20conversion%20can%20be%20overridden%20by%20custom%20conversion%3C/li%3E%20%3C/ul%3E%20%3Cp%3EMultiple%20end-points%20can%20be%20implemented%20in%20a%20single%20webservice%20application%3C/p%3E%20%3Cp%3EBuilt-in%20test%20mode,%20for%20testing%20from%20within%20the LogicNets Visual%20designer%20environment%3C/p%3E%20%3Ch1%3EHow%20to%20set%20up a WebServices application%20project%3C/h1%3E%20%3Cp%3EIn%20the%20designer%20there%20are%20template%20projects%20that%20can%20be%20selected.%3C/p%3E%20%3Cp%3EGRAPHIC%3C/p%3E%20%3Cp%3EOnce%20a%20new%20project%20has%20been%20created,%20build%20the%20end-point\(s\)%20of%20the%20web-service%20application. An%20end-point%20is%20a%20function%20that%20is%20exposed%20by%20the%20webservice,%20and%20each%20end-point%20is%20represented%20by%20a logicnet in%20the%20end-points%20folder%20of%20your%20project.%3C/p%3E%20%3Ch1%3EWebServices URLs%3C/h1%3E%20%3Cp%3EThe%20URL%20of%20your%20webservice%20is%20composed%20of%20the%20following%20three%20parts:%20the%20host%20name,%20the%20start%20code%20and%20the%20end-point%3C/p%3E%20%3Cp%3Ehttps:/<host-name>/<start-code%20of%20your%20webservice>/<end-point>%3C/p%3E%20%3Cp%3EFor%20a%20project%20with%20a%20startcode%20of%20demostart%20and%20an%20endpoint%20called%20endpoint_net,%20the%20URL%20would%20be%20https:/logicnets-demo.com/demostart/endpoint_net%3C/p%3E%20%3Cp%3EThe%20start-code%20of%20your%20web-service%20can%20be%20specified%20on%20your%20project%20settings%20page%3C/p%3E).

You specify the start code of your web service on your project settings page: ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-ef01492e27f16f2f361479470eb7cd9f2411f32e%2F5ce2cf09-7628-4760-bf54-e9c3b1d69d0e.png?alt=media)

## End Points

The logicnets in the *endpoints* folder are the endpoints for your web service, and the web service calls endpoints by their name. For example, the logicnet *function\_1* will be exposed as an endpoint and can be invoked by the following URL: https\:////function\_1 .

You can also use folders to organize endpoints. If you do that, you need to incorporate the folder name in the endpoint path; for example, the endpoint can be invoked by the following URL: https\:////group\_1/function\_1 .

The endpoint logicnet is the place where you start modeling the logic. Except for form nodes that post information to the UI, all modeling components are available for the logic.

## Special End Points

The system treats endpoints with the following names slightly differently: main, get, post, put, delete, and patch. If your endpoint has one of the these names, the names do not need to appear in the URL.

The URL to invoke the logicnet called *main* would be https\:///\<start code of your web service . The name *main* does not need to appear in the URL, as *main* resolves to its parent folder in the endpoints folder. The URL to invoke the logicnet called post would be https\:/// but it will have the HTTP method POST.

With *main* it is also possible to model one single (main-)entry of your web service application where you can route the call further to other logicnets within your application.

## Testing

You can test your web service application using third-party test tools like Postan, SOAP UI. However, LogicNets also includes a test mode that allows you to test your application from the Designer. To use the test mode click the *test* button or CTRL+F8 key. ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-f7343f98db0057a0bccc4c64084c68ae847c8d87%2F5a8d81f7-6778-41fc-9a9a-29df925754a2.png?alt=media)

You can configure the request URL, parameters, content type, and body in the top section of the testing tool. The bottom section displays the returned result and request result code.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/web-services-framework/web-services-framework-overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.