1. Home
  2. Using Warewolf
  3. Web Service Endpoints

Web Service Endpoints

Web service endpoints in Warewolf are URLs.

Each Service is a mashup of tools and resources. These services are accessed from the outside by executing the web URL as a RESTFUL web service.

To access the endpoint in this way, the caller must have View and Execute permissions.

The end points are made up as follows (italics is programmable and bold is mandatory):

http or https :// ServerAddress : Port / services / Folder…(n) / Service Name .jason or .xml ? Input String 

e.g. https://myserver.com:3143/services/InsertCustomer.json?FirstName=Bart&Surname=Simpson

 http or https

All endpoints are automatically available over http or https, provided the corresponding port is open. By default http traffic will go through port 3142 and https traffic will use 3143.

ServerAddress

This could be an IP address, computer name on the network or domain name. Not case sensitive.

Port

The port at that ServerAddress that Warewolf is listening on. Typically 3142 for http Warewolf requests and 3143 for https requests.

Folder…(n)

The folder structure under which the service can be found. This could be many nested folders. Not case sensitive.

Service Name

The saved name of the service in the folder above. Not case sensitive.

.JSON or .XML

Defines if the response data should be returned as JSON or XML. If neither is defined, the default is XML.

Input String

To pass data into the service, use query string notation: Variable=value&variable2=value2… To pass in recordset values use xml:

[[Family(1).Name]] = Bart [[Family(1).Surname]] = Simpson
[[Family(2).Name]] = Lisa [[Family(2).Surname]] = Simpson
[[Family(3).Name]] = Homer [[Family(3).Surname]] = Simpson

Would be passed in as a long xml string:

<DataList><Family><Name>Bart</Name><Surname>Simpson</Surname></Family><Family><Name>Lisa</Name><Surname>Simpson</Surname></Family><Family><Name>Homer</Name><Surname>Simpson</Surname></Family></DataList>

 

NOTE: The <DataList> tags are mandatory when using this method. Also, Scalars can be passed in in the same way.

Not what you were looking for? Ask our expert users in the Community Forum.

FacebookTwitterLinkedInGoogle+Email
Updated on July 19, 2017

Was this article helpful?

Related Articles