retrieve the annotated document

The following URL has to be used to retrieve the annotated WSDL file for the Web service with the service ID "d022cec". The original URL included the request parameter ?wsdl, which is commonly used to retrieve a WSDL description of a W3C-compliant Web service.

URL:  http://semantic-proxy.appspot.com/api/get?

Parameter:

  • sid - a unique identifier for the Web service
  • one or more original parameters, the keys are service type specific.

Supported HTTP Methods: (using other methods results in 405)

  • GET

HTTP Response:

  • 200 - request has succeeded
  • 303 - see other, will be returned if the source stream will not be modified, and the client should request the original source instead
  • 400 - Bad Request: if required parameter is missing
  • 404 - Not Found: if given service id is not registered
  • 405 - Method not allowed
  • 500 - Internal Server Error
  • 502 - Bad Gateway: service id registered, but failed to access upstream server

Examples:

http://semantic-proxy.appspot.com/api/get?service=WFS&version=1.1.0&request=getCapabilities&sid=d022cec 
http://semantic-proxy.appspot.com/api/get?sid=d022cec&wsdl

upload an annotated document

You can upload a manually annotated XML document, either with our upload form, or with this API method. We try to parse the XML, and store all references in the database. If the resource has been successfully created, the service will respond with Status Code 201 (CREATED) and a forward to the operation /api/list/references with the generated service id).

URL:  http://semantic-proxy.appspot.com/api/put?

Parameter: (encoded as multipart/form-data)

  • service_request- the URL pointing to the metadata document (including all parameters)
  • uploaded_file - a document containing the annotated XML

Supported HTTP Methods: (using other methods results in 405)

  • POST
  • PUT

HTTP Response:

  • 201 - metadata has been parsed and stored in the database (default)
  • 400 - Bad Request: if required parameter is missing
  • 405 - Method not allowed
  • 415 - the service type or metadata is not supported by the proxy
  • 500 - Internal Server Error
  • 502 - Bad Gateway: failed to access upstream server identified by serviceURL

list all references

URL:  http://semantic-proxy.appspot.com/api/list/references? Parameter: (encoded as multipart/form-data)

  • sid - a unique identifier for the Web service

Supported HTTP Methods:

  • GET

HTTP Response:

  • 200 - OK
  • 400 - Bad Request: if required parameter is missing
  • 404 - Not Found: if given service id is not registered
  • 500 - Internal Server Error

Example Request:

URL: http://semantic-proxy.appspot.com/api/list/references&sid=d022cec 
Response: 

Example Response (JSON):

{
"sid": "d022cec", 
"list": {
 "binding": {
  "name": "//wps:ProcessDescriptions/wps:ProcessDescription/ows:Identifier/text()='e323' ...", 
  "reference": "<ows:Metadata xmlns:wps=\"http://www.opengeospatial.net/wps\" xmlns:ows=\"http://www.opengeospatial.net/ows\" ...."  },
 "binding": {
  "name": "//wsdl:Definitions/ ...", 
  "reference": "sawsdl:modelReference=\"http://www.example.com/concepts/MyConcept\"" ...."  },
 }
}

list all registered services

URL:  http://semantic-proxy.appspot.com/api/list/services

Supported HTTP Methods:

  • GET

HTTP Response:

  • 200 - OK
  • 500 - Internal Server Error

Example Request:

 http://semantic-proxy.appspot.com/api/list/services

Example Response (JSON):

{
"list": {
 "service" {
  "sid": "d022cec", 
  "url": "http://www.example.com
 }
 "service" {
  "sid": "e620i24", 
  "url": "http://www.foobar.com
 }
}