Swagger Sample
A sample swagger server
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
get /formfolderspost /formfoldersget /formfolders/{folderId}put /formfolders/{folderId}delete /formfolders/{folderId}get /formfolders/{folderId}/formsget /formfolders/{folderId}/forms/{formId}get /formfolders/{folderId}/forms/{formId}/attributesget /formfolders/{folderId}/forms/{formId}/attributes/{attrID}get /formfolders/{folderId}/forms/{formId}/offersget /formfolders/{folderId}/forms/{formId}/offers/{offerID}get /formfolders/{parentFolderId}/subfolderspost /formfolders/{parentFolderId}/subfolders
Lists all folders used for forms. (getAllFolders)
Returns all folders.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
500
Internal server error while fetching folders
404
There are no folders
Creates a new folder. (createFolder)
Returns a URI of the newly created folder in the response header with the name 'Location'.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The folder object that needs to be created.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Folder created successfully
401
User is not an administrator. Unauthorized request.
500
Internal server error while creating new folder.
Up
get /formfolders/{folderId}
Finds a folder by ID. (getFolder)
Returns a single folder.
Path parameters
folderId (required)
Path Parameter — The ID of a folder.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
401
User is not an administrator. Unauthorized request.
500
Internal server error while fetching folder data.
404
Folder not found
Up
put /formfolders/{folderId}
Updates an existing folder. (updateFolder)
Returns 204 status if the update is successful.
Path parameters
folderId (required)
Path Parameter — The ID of a folder.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The folder object that needs to be updated.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
401
User is not an administrator. Unauthorized request.
500
Internal server error while updating folder.
204
Folder updated successfully
404
Folder not found
Up
delete /formfolders/{folderId}
Deletes an existing folder. (deleteFolder)
Returns 204 status if the delete is successful.
Path parameters
folderId (required)
Path Parameter — ID of a folder
Responses
401
User is not an administrator. Unauthorized request.
500
Internal server error while deleting folder.
204
Folder deleted successfully
404
Folder not found
Up
get /formfolders/{folderId}/forms
Lists all forms. (getAllForms)
Returns details of a form in JSON format.
Path parameters
folderId (required)
Path Parameter — ID of a folder
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 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 /formfolders/{folderId}/forms/{formId}
Finds a form by using the form ID. (getForm)
Fetches a form based on the form ID.
Path parameters
folderId (required)
Path Parameter — ID of a folder
formId (required)
Path Parameter — The ID of a form.
Produces
This API call produces the following media types according to the 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 /formfolders/{folderId}/forms/{formId}/attributes
Lists all form attributes for the specified form ID. (getAllFormAttribute)
Returns all form attributes in JSON format.
Path parameters
folderId (required)
Path Parameter — ID of a folder
formId (required)
Path Parameter — The ID of a form.
Produces
This API call produces the following media types according to the 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 /formfolders/{folderId}/forms/{formId}/attributes/{attrID}
Fetches a form attribute based on the attribute ID. (getFormAttribute)
Returns all templates.
Path parameters
folderId (required)
Path Parameter — ID of a folder
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 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 /formfolders/{folderId}/forms/{formId}/offers
Lists all offers IDs for the specified form ID. (getAllFormOffersIDs)
Returns all form offers IDs.
Path parameters
folderId (required)
Path Parameter — ID of a folder
formId (required)
Path Parameter — The form ID.
Produces
This API call produces the following media types according to the 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 /formfolders/{folderId}/forms/{formId}/offers/{offerID}
Fetches an offer for the specified offer ID. (getFormOffer)
Returns an offer view for the specified offer ID.
Path parameters
folderId (required)
Path Parameter — ID of a folder
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 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
get /formfolders/{parentFolderId}/subfolders
Gets subfolders from the parent folder. (getAllSubFolders)
Returns a list of folder objects.
Path parameters
parentFolderId (required)
Path Parameter — The ID of the parent folder.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
500
Internal server error while retrieving sub folders from parent folder.
404
Sub Folders not found in parent folder or parent folder not found
Up
post /formfolders/{parentFolderId}/subfolders
Creates a subfolder under the parent folder. (createSubFolder)
Returns a URI of the newly created folder in the response header with the name 'Location'.
Path parameters
parentFolderId (required)
Path Parameter — The ID of the parent folder.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — The folder object that needs to be created.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Sub Folder created successfully in parent folder
401
User is not an administrator. Unauthorized request.
500
Internal server error while creating sub folders in parent folder.
404
Parent folder not found
[ Jump to Methods ]
Table of Contents
FormOfferVOAttributeVOFolderVOFormVO
offerId
Integer Offer ID
offerName
String Offer Name
description
String Offer Description
cellID
Integer Offer Cell ID
helpTip
String Offer Help Tip
Attribute_Type
String Attribute Type
Attribute_ID
Integer Attribute ID
Dependent_Flag
Boolean Is dependent flag
Requied_Flag
Boolean Is Required flag
Parameter_Type
String Parameter type for attribute
Dependent_Colunms
array[String] List of dependent colunms
Lookup_Options
array[String] Lookup options
Internal_Name
String Attribute Internal Name
Display_Name
String Attribute Display Name
Lookup_Sort_Ascending_Flag
Boolean Is Lookup Sort Ascending flag
SSDOR_Cols_Names
array[String] List of SDOR Cols Names
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
folderId
Integer
folderName
String
description
String Description of folder
parentId
Integer Folder Name
folderType
String Type of folder. Can be template or form
State
String State
Description
String Form Description
Last_Modified_Date
String Last Modify Date
Creation_Date
String Creation Date
Form_ID
Integer Form ID
Templates_Using_This_Form
Map[int,string] Name of template using this form
Name
String Form Name
Published_Status
String Published status
Previous_Published_State
Integer Previous Published state
Attributes_IDs
array[Integer] Attributes in form