{
	"apiVersion": "1.2",
	"swaggerVersion": "1.2",
	"basePath": "https://www.spectrumemp.com/api",
	"resourcePath": "/forms",
	"produces": [
		"application/json",
		"application/xml"
	],
	"apis": [{
		"path": "/forms/requirements",
		"description": "Operations about the form fields and requirements",
		"operations":[{
			"method":"GET",
			"nickname":"getFormFieldRequirements",
			"type":"FormRequirements",
			"parameters":[{
			    "name" : "IQS-API-KEY",
			    "description" : "client API key",
			    "required" : true,
			    "type" : "string",
			    "paramType" : "query"
			},
			{
			    "name" : "formID",
			    "description" : "optional form ID from /forms/submittable, otherwise defaults to Inquiry Form",
			    "required" : false,
			    "type" : "integer",
			    "paramType" : "query"
			}],
			"summary":"Find all fields and field options for form submission",
			"notes": "All fields on the form will be returned, along with their options",
			"responseMessage": [{
				"code": 200,
				"message": "Ok",
				"responseModel": "FormRequirements"
				},
				{
				"code": 404,
				"message": "The form cannot be found"
			}]
		}]
	},
	{
		"path": "/forms/submit",
		"description": "Operations about form submission",
		"operations":[{
			"method":"POST",
			"nickname":"submitForm",
			"type":"void",
			"parameters":[
				{
				  "name" : "IQS-API-KEY",
				  "description" : "client API key",
				  "required" : true,
				  "type" : "string",
				  "paramType" : "query"
				},
				{
	              "name": "{{fieldID}}",
	              "description": "The parameter must be the ID number of the field being posted",
	              "required": true,
	              "type": "integer",
	              "paramType": "data"
	            },
	            {
	              "name": "{{fieldID}}",
	              "description": "The parameter must be the ID number of the field being posted",
	              "required": true,
	              "type": "integer",
	              "paramType": "data"
	            },
	            {
	              "name": "{{fieldID}}",
	              "description": "The parameter must be the ID number of the field being posted",
	              "required": true,
	              "type": "integer",
	              "paramType": "data"
	            },
				{
				  "name" : "formID",
				  "description" : "optional form ID from /forms/submittable, otherwise defaults to Inquiry Form",
				  "required" : false,
				  "type" : "integer",
				  "paramType" : "query"
				},
				{
				  "name" : "SOURCE",
				  "description" : "optional supplemental source ID from /sources/list to add to student's sources",
				  "required" : false,
				  "type" : "integer",
				  "paramType" : "query"
				},
				{
				  "name" : "UPDATE-EXISTING-PROSPECTS",
				  "description" : "optional boolean flag (0 or 1) to update student information if they are a prospect (DEPRECATED)",
				  "required" : false,
				  "type" : "boolean",
				  "paramType" : "query"
				}
			],
			"summary":"Submit form",
			"notes": "Accepts all fields returned from /forms/requirements. Payment options will be omitted when using this API. Please note that this resource cannot be tested from this site",
			"responseMessage": [{
				"code": 200,
				"message": "Ok"
				},
				{
				"code": 404,
				"message": "The form cannot be found"
			}]
		}]
	},
	{
		"path": "/forms/submittable",
		"description": "Operations about the non-event SEM forms",
		"operations":[{
			"method":"GET",
			"nickname":"getSubmittableForms",
			"type":"SubmittableForms",
			"parameters":[{
			    "name" : "IQS-API-KEY",
			    "description" : "client API key",
			    "required" : true,
			    "type" : "string",
			    "paramType" : "query"
			}],
			"summary":"Find all non-event SEM forms",
			"notes": "All non-event SEM forms will be returned, along with their ids",
			"responseMessage": [{
				"code": 200,
				"message": "Ok",
				"responseModel": "SubmittableForms"
				},
				{
				"code": 404,
				"message": "The form cannot be found"
			}]
		}]
	}],
	"models": {
		"FormRequirements": {
			"type":"object",
			"id": "FormRequirements",
			"required":false,
			"properties":{
				"data": {
					"type":"object",
					"required":false,
					"items":{
						"$ref":"data"
					}
				},
				"status": {
					"type":"string",
					"required":false
				}
			}
		},
		"SubmittableForms": {
			"type":"object",
			"id": "SubmittableForms",
			"required":false,
			"properties":{
				"data": {
					"type":"object",
					"required":false,
					"items":{
						"$ref":"data"
					}
				},
				"status": {
					"type":"string",
					"required":false
				}
			}
		},
		"data": {
			"type":"object",
			"id": "data",
			"required":false,
			"properties":{
				"form": {
					"type": "object",
					"items": {
						"$ref":"form"
					}
				},
				"sections": {
					"type": "object",
					"items": {
						"$ref":"sections"
					}
				},
				"assetDependencies": {
					"type":"array",
					"items":{
						"$ref":"assetDependencies"
					}
				}
			}
		},
		"dataSubmittableForms": {
			"type":"object",
			"id": "data",
			"required":false,
			"properties":{
				"sem_forms": {
					"type": "object",
					"items": {
						"$ref":"sem_form"
					}
				}
			}
		},
		"form": {
			"type": "object",
			"properties": {
				"pageTitle": {
					"type": "string"
				},
				"metaDescription": {
					"type": "string"
				},
				"header": {
					"type": "string"
				},
				"subHeader": {
					"type": "string"
				}
			}
		},
		"sem_form": {
			"type": "object",
			"properties": {
				"name": {
					"type": "string"
				},
				"id": {
					"type": "string"
				}
			}
		},
		"sections": {
			"type":"object",
			"required":false,
			"properties":{
				"sectionID": {
					"type":"array",
					"items":{
						"$ref":"section"
					}
				}
			}
		},
		"section": {
			"type":"object",
			"required":false,
			"properties":{
				"name": {
					"type": "string"
				},
				"description": {
					"type": "string"
				},
				"order": {
					"type": "string"
				},
				"fields": {
					"type":"array",
					"items":{
						"$ref":"field"
					}
				}
			}
		},
		"field": {
			"type":"object",
			"required":false,
			"properties":{
                "order": {
					"type": "string"
				},
				"required": {
					"type": "string"
				},
				"hidden": {
					"type": "string"
				},
				"default": {
					"type": "string"
				},
				"helpText": {
					"type": "string"
				},
				"hasOptions": {
					"type": "string"
				},
				"isAssetField": {
					"type": "string"
				},
				"id": {
					"type": "string"
				},
				"displayName": {
					"type": "string"
				},
				"type": {
					"type": "string"
				},
				"description": {
					"type": "string"
				},
				"htmlElement": {
					"type": "string"
				},
				"options": {
					"type":"array",
					"items":{
						"$ref":"option"
					}
				}
			}
		},
		"option": {
			"type":"object",
			"id": "option",
			"required":false,
			"properties":{
				"id": {
					"type":"string"
				},
				"value": {
					"type":"string"
				}
			}
		},
		"assetDependencies": {
			"type":"object",
			"id": "assetDependencies",
			"required":false,
			"properties":{
				"dependencies": {
					"type":"array",
					"items":{
						"$ref":"dependancy"
					}
				}
			}
		},
		"dependancy": {
			"type":"object",
			"id": "dependancy",
			"required":false,
			"properties":{
				"parentFieldID": {
					"type":"string"
				},
				"childFieldID": {
					"type":"string"
				}
			}
		}
	}
}