Swagger Sample

A sample swagger server
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /forms
  2. get /forms/{formId}
  3. get /forms/{formId}/attributes
  4. get /forms/{formId}/attributes/{attrID}
  5. get /forms/{formId}/offers
  6. get /forms/{formId}/offers/{offerID}
Up
get /forms
Lists all forms. (getAllForms)
Returns details of a form in JSON format.

Query parameters

state (optional)
Query Parameter — The state of the form.
publishStatus (optional)
Query Parameter — The publish status of the form.
createdDate (optional)
Query Parameter — The form creation date in the format yyyy-MM-dd.
lastModifiedDate (optional)
Query Parameter — The form last modification date in the format yyyy-MM-dd.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success

500

Internal server error while fetching form date

404

There are no form

Up
get /forms/{formId}
Finds a form by using the form ID. (getForm)
Fetches a form based on the form ID.

Path parameters

formId (required)
Path Parameter — The ID of a form.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success

500

Internal server error while fetching form data.

404

Form not found

Up
get /forms/{formId}/attributes
Lists all form attributes for the specified form ID. (getAllFormAttribute)
Returns all form attributes in JSON format.

Path parameters

formId (required)
Path Parameter — The ID of a form.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success

500

Internal server error while fetching form attributes

404

There are no form attributes

Up
get /forms/{formId}/attributes/{attrID}
Fetches a form attribute based on the attribute ID. (getFormAttribute)
Returns all templates.

Path parameters

formId (required)
Path Parameter — The ID of a form.
attrID (required)
Path Parameter — The attribute ID for an attribute.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success

500

Internal server error while fetching form attribute

404

There is no form attribute

Up
get /forms/{formId}/offers
Lists all offers IDs for the specified form ID. (getAllFormOffersIDs)
Returns all form offers IDs.

Path parameters

formId (required)
Path Parameter — The form ID.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success

500

Internal server error while fetching form offers ids

404

There are no form offers ids

Up
get /forms/{formId}/offers/{offerID}
Fetches an offer for the specified offer ID. (getFormOffer)
Returns an offer view for the specified offer ID.

Path parameters

formId (required)
Path Parameter — The form ID.
offerID (required)
Path Parameter — The offer ID for a form.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success

500

Internal server error while fetching form offer

403

User is not an administrator. Request is forbidden

404

There is no offer

Up

Models

[ Jump to Methods ]

Table of Contents

  1. FormOfferVO
  2. AttributeVO
  3. FormVO

FormOfferVO Up

offerId
Integer Offer ID
offerName
String Offer Name
description
String Offer Description
cellID
Integer Offer Cell ID
helpTip
String Offer Help Tip

AttributeVO Up

Attribute_ID
Integer Attribute ID
Internal_Name
String Attribute Internal Name
Display_Name
String Attribute Display Name
Attribute_Type
String Attribute Type
Requied_Flag
Boolean Is Required flag
Parameter_Type
String Parameter type for attribute
Lookup_Options
array[String] Lookup options
Lookup_Sort_Ascending_Flag
Boolean Is Lookup Sort Ascending flag
SSDOR_Cols_Names
array[String] List of SDOR Cols Names
Dependent_Flag
Boolean Is dependent flag
Dependent_Colunms
array[String] List of dependent colunms
Max_Length
Integer Max length for attribute
Attribute_Precision
Integer Attribute Precision
Description
String Attribute Description
Help
String Attribute help
Default_Value_For_Options
String Default value for options
Special_Behavior
String Attribute Special behavior
Attribute_Message
String Attribute Message
Actual_Message
String Actual Message for attribute
Group_ID
Integer Group ID
Group_Internal_Name
String Group Internal Name
Group_Display_Name
String Group Display Name

FormVO Up

Form_ID
Integer Form ID
Name
String Form Name
Description
String Form Description
Previous_Published_State
Integer Previous Published state
Published_Status
String Published status
Enum:
NEW
INVALID
VALID
REVIEW
FORM_DELETED
TO_MERGE
State
String State
Enum:
Published
Non Published
Disabled
Temporary
Deleted
Templates_Using_This_Form
Map[int,string] Name of template using this form
Attributes_IDs
array[Integer] Attributes in form
Creation_Date
String Creation Date
Last_Modified_Date
String Last Modify Date