GET /api/dropbox/wsdls?wsdlUrl={url}

Accepts the URL for a WSDL file and returns a list of operations, starting with the ID of the WSDL.

Authorization Roles/Permissions: Must be logged in. Must be either an authorized user for the resource or a site admin. In addition, the WSDL URL must be a trusted source.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/dropbox/wsdls?wsdlUrl={url}

Back to top

Sample Request

The example below shows an API call to upload the US Government weather service WSDL file.

Request URL

https://{hostname}/api/dropbox/wsdls?wsdlUrl=https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php?wsdl

Sample request headers

Accept: text/plain
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept text/plain
Content-Type Any format (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
wsdlUrl query string Required The URL of the WSDL file to be read.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the content of the WSDL file.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Cache-Control: no-cache, no-store
Content-Type: text/plain
Date: Wed, 16 May 2018 18:23:53 GMT

Sample response body

{
  "wsdlId":"1004",
  "Operations":[
    "NDFDgen",
    "NDFDgenLatLonList",
    "LatLonListSubgrid",
    "LatLonListLine",
    "LatLonListZipCode",
    "LatLonListCityNames",
    "LatLonListSquare",
    "CornerPoints",
    "GmlLatLonList",
    "GmlTimeSeries",
    "NDFDgenByDay",
    "NDFDgenByDayLatLonList"
  ]
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

The response body is the content of the WSDL file; a list of operations, starting with the WSDL ID.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
403

This operation returns a 403 error in either of these scenarios:

  • If the protocol is anything other than HTTP or HTTPS
  • If the value for the wsdlUrl parameter is set to localhost or 127.0.0.1.
500

An error occurred processing the call. This operation returns a 500 error in either of these scenarios:

  • If there is no trusted certificate for the URL existing in the installation (Policy Manager trust store).
  • If the protocol is invalid.

More information about Akana API Platform API error messages.

Back to top

Related Topics