Requests to the FlowWorks WebAPI use the following basic format:
The <version #> refers to the API version you are requesting.
The <apikey> is your unique identifier and must be included on every request.
The <resource> describes the resource you are requesting. For a complete list of available resources, see the "Resources" topic.
Each response contains the following:
- Requeststatus: integer value of 0 or 1 -- representing success or failure.
- msg: string containing a message describing the result and any errors that occurred. See "Appendix B: Response Messages" for complete listing.
- username: string containing the name of the user associated with the API key that made the request.
- A collection of the resources you requested. See "Resources" topic for examples.