pivotal.json

{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "Applink API",
        "description": "Submit a sample application to the Applink API"
    },
    "host": "ec2-50-16-88-196.compute-1.amazonaws.com:8080",
    "basePath": "/DataGatewayService.svc",
    "schemes": [
        "http"
    ],
    "consumes": [
      	"application/xml",
      	"application/pdf"
    ],
    "produces": [
      	"application/xml"
    ],
    "paths": {
        "/Submit/CA/application.xml": {
            "post": {
                "description": "Applink API submit application",
                "operationId": "submit_app",
                "produces": [
                    "application/xml"
                ],
              	"consumes": [
                  	"multipart/form-data"
                ],
                "parameters": [
                    {
                        "name": "File",
                        "in": "body",
                        "description": "Your example application",
                        "required": true,
                        "paramType": "form",
                        "type": "File"
                    },
                    {
                        "name": "body",
                        "description": "Definition of fileUploadRequest",
                        "required": true,
                        "type": "fileUploadRequest",
                        "contentType": "application/xml",
                      	"paramType": "body"
                    },
                  	{
                    	"name": "user_key",
                    	"in": "header",
                    	"description": "your API access key",
                    	"x-data-threescale-name": "user_keys",
                      	"required": true,
                    	"type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "response",
                        "schema": {
                            "$ref": "#/definitions/ResponseModel"
                        }
                    },
                    "default": {
                        "description": "unexpected error",
                        "schema": {
                            "$ref": "#/definitions/ErrorModel"
                        }
                    }
                }
            }
        },
        "/File/{submission_Id}/Supporting/merchant_and_application_agreement.pdf": {
            "put": {
                "description": "Submit supporting documents and ID to Applink API",
                "operationId": "file_submission",
                "produces": [
                    "application/json",
                    "application/xml",
                    "text/xml",
                    "text/html",
                  	"application/pdf"
                ],
              	"consumes": [
                	"multipart/form-data"
                ],
                "parameters": [
                    {
                        "name": "submission_Id",
                        "in": "path",
                        "description": "The submission Id retrieved from the initial call",
                        "required": true,
                        "type": "string"
                    },
                    {
                        "name": "user_key",
                        "in": "header",
                        "description": "Your API access key",
                        "required": true,
                        "x-data-threescale-name": "user_keys",
                        "type": "string"
                    },
                  	{
                    	"name": "merchant_application_and_agreement.pdf",
                    	"in": "body",
                    	"description": "Agreement PDF file",
                    	"required": true,
                    	"type": "File",
                      	"paramType": "form"
                    },
                  	{
                    	"name": "contentType",
                    	"in": "query",
                    	"required": "true",
                    	"x-is-map": false,
                    	"type": "string",
                    	"enum": [
                          "Merchant_Application_And_Agreement"
                        ],
                    	"description": "always set to this value"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "response",
                        "schema": {
                            "$ref": "#/definitions/ResponseModel"
                        }
                    },
                    "default": {
                        "description": "unexpected error",
                        "schema": {
                            "$ref": "#/definitions/ErrorModel"
                        }
                    }
                }
            }
        },
      	"/Submission/{submission_Id}/Submit": {
        	"post": {
            	"description": "Confirm submission of the application",
            	"operationId": "submit_confirmation",
            	"produces": [
                  "application/json",
                	"application/xml"
                ],
            	"parameters": [
                  	{
                    	"name": "submission_Id",
                    	"in": "path",
                    	"description": "The submission Id retrieved from the initial call",
                    	"required": true,
                    	"type": "string"
                    },
                    {
                    	"name": "user_key",
                    	"in": "header",
                    	"description": "Your API access key",
                    	"required": true,
                    	"x-data-threescale-name": "user_keys",
                    	"type": "string"
                    }
                ]
            }
        }
    },
    "definitions": {
        "ResponseModel": {
            "type": "object",
            "required": [
                "method",
                "path",
                "args",
                "headers"
            ],
            "properties": {
                "method": {
                    "type": "string"
                },
                "path": {
                    "type": "string"
                },
                "args": {
                    "type": "string"
                },
                "headers": {
                    "type": "object"
                }
            }
        },
        "ErrorModel": {
            "type": "object",
            "required": [
                "code",
                "message"
            ],
            "properties": {
                "code": {
                    "type": "integer",
                    "format": "int32"
                },
                "message": {
                    "type": "string"
                }
            }
        }
    }
}