POST /api/dropbox/wsdls

Deprecated in version 2024.1.0.

Accepts a ZIP file containing a WSDL and responds with a list of operations.It could return a list of files in the ZIP file for the user to select. A resend is then required with the filename. A successful send 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.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/dropbox/wsdls

Sample Request

The example below includes the WSDL file in the request body.

Sample Request URL 

https://{hostname}/api/dropbox/wsdls?wrapInHTML=true&document.domain=api.acmepaymentscorp.com

Sample request headers 

POST /api/dropbox/wsdls?wrapInHTML=true&document.domain=api.acmepaymentscorp.com HTTP/1.1
Host: {hostname}
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

(large file).

Request Headers

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

Header Description
Accept text/plain
Content-Type multipart/form-data
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

Request Parameters

Parameter Parm Type Data Type Required Description
FileName Form string Required The filename for the WSDL file to be read. For more information, see Managing Multipart/Form-Data Uploads.

Note: For information about the wrapInHTML parameter shown in the sample request above, see File Upload with Ajax. This is only used if you are running the API in a browser context.

Response

If successful, this operation returns HTTP status code 200, with a listing of the contents of the WSDL ZIP file.

Sample Response

The sample response below shows the plain text contents of the WSDL file that was uploaded, expressed in HTML.

Sample response headers 

HTTP/1.1 200 OK
Date: Fri, 18 Jan 2013 11:31:18 GMT
Content-Type: text/html

Sample response body 

<!DOCTYPE html><html lang="en"><head><meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<meta content="IE=edge" http-equiv="X-UA-Compatible">
<meta name="description" content="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris lacus elit, 
ornare eget luctus vel, porta id elit. Maecenas molestie, libero sit amet blandit faucibus, orci nisi aliquet nisi, 
id mollis mauris ipsum a enim. Morbi lacus velit, placerat sit amet luctus eget, pulvinar a massa. Lorem ipsum dolor sit amet, 
consectetur adipiscing elit. Morbi eleifend tincidunt pellentesque. Cras eu sapien massa, vitae rutrum sapien. Aenean id 
condimentum sem. Suspendisse tempor luctus ipsum, vel metus."><script type="text/javascript">document.domain='api.acmepaymentscorp.com';
</script></head><body>PersonService.wsdl,xsd0.xsd,xsd1.xsd,xsd10.xsd,xsd11.xsd,xsd12.xsd,xsd13.xsd,xsd14.xsd,xsd15.xsd,xsd2.xsd,
xsd3.xsd,xsd4.xsd,xsd5.xsd,xsd6.xsd,xsd7.xsd,xsd8.xsd,xsd9.xsd</body></html>

Note: for information about the HTML wrapper shown in the sample response above, see File Upload with Ajax.

Response Headers

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

Header Description
Content-Type text/plain

Response Body

The response body is a listing of the contents of the WSDL ZIP file.

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.