{
	"info": {
		"_postman_id": "f7126c23-2cb6-4509-b52b-5f78ea70b22e",
		"name": "FileCap API example",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Upload files",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "APIKey",
							"value": "HKADASD68768768ASDASDASDAD",
							"description": "The FileCap server API key",
							"type": "text"
						},
						{
							"key": "ids",
							"value": "263478632784632748237513",
							"description": "The ID of the transfer",
							"type": "text"
						},
						{
							"key": "from",
							"value": "kees@example.com",
							"description": "The email address of the sender",
							"type": "text"
						},
						{
							"key": "subject",
							"value": "API Test",
							"description": "The subject of the transfer",
							"type": "text"
						},
						{
							"key": "comment",
							"value": "This is a test",
							"description": "The comment/message for the transfer",
							"type": "text"
						},
						{
							"key": "encryptMessage",
							"value": "true",
							"description": "Optional; The comment/message will be encrypted. At this moment only unformatted text is supported.",
							"type": "text",
							"disabled": true
						},
						{
							"key": "rec0",
							"value": "kees@receiver.com",
							"description": "A list of receivers of the transfer the first receiver would be rec0, second rec1 and the next rec2, rec3 etc.",
							"type": "text"
						},
						{
							"key": "rec1",
							"value": "henk@receiver2.com",
							"description": "A list of receivers of the transfer the first receiver would be rec0, second rec1 and the next rec2, rec3 etc.",
							"type": "text",
							"disabled": true
						},
						{
							"key": "storeDays_value",
							"value": "5",
							"description": "Optional; How long will the transfer stay on the FileCap server",
							"type": "text",
							"disabled": true
						},
						{
							"key": "downloadLoadable_value",
							"value": "10",
							"description": "Optional; How many times can files be downloaded",
							"type": "text",
							"disabled": true
						},
						{
							"key": "password",
							"value": "test1234",
							"description": "Optional; Password is mandatory when encryptMessage = true",
							"type": "text",
							"disabled": true
						},
						{
							"key": "dontNotify",
							"value": "true",
							"description": "Optional; When true there will not be send an email from the FileCap server to the receiver. The 3th party system should handle this.",
							"type": "text",
							"disabled": true
						},
						{
							"key": "file01",
							"value": "",
							"description": "A list of files in this transfer the first file would be file01, second file02 and the next file03, file04 etc.",
							"type": "file"
						},
						{
							"key": "file02",
							"value": "",
							"description": "A list of files in this transfer the first file would be file01, second file02 and the next file03, file04 etc.",
							"type": "file",
							"disabled": true
						}
					]
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/process_upload.jsp",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"process_upload.jsp"
					]
				},
				"description": "process_upload.jsp can be used to upload files to the FileCap server.\nThe data that is being send needs to be in an multipart/form HTTP POST.\n\nThe result of this request can be true or false:\n- When the transfer was successful, the result will be true.\n- When the transfer was unsuccessful, the result will be false with an error message.\n\nThe following text can be in the error message:\n- VIRUS_FOUND - There is a virus found in the uploaded file. The transfer has been cancelled. \n- NO_RECIPIENT_GIVEN - You did not specify any recipients for the transfer. \n- FILETYPE_NOT_ALLOW - The filetype is not allowed, either because of a forbidden MIME type or forbidden file extension. \n- PASSWORD_MANDATORY_BUT_NOT_GIVEN - The administrator set the use of a password as mandatory, but none is given in the transfer options. \n- CANNOT_SEND_MAIL - The FileCap server was not able to send the email. Most commonly either the mail server was not configured correct, or the FileCap server is not authenticated to relay mail. \n- API_KEY_INVALID - The given API Key was invalid and cannot be used. \n- GENERAL_ERROR - There was an unknown error. Please check the server logs for the exception. If this error occurs you probably have a network / proxy issue"
			},
			"response": []
		},
		{
			"name": "Send invite",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"type": "text",
						"value": "application/x-www-form-urlencoded"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "APIKey",
							"value": "HKADASD68768768ASDASDASDAD",
							"description": "The FileCap server API key",
							"type": "text"
						},
						{
							"key": "id",
							"value": "iiiii26347863278463274823755",
							"description": "Invite id always needs to start with: iiiii",
							"type": "text"
						},
						{
							"key": "senderEmail",
							"value": "kees@example.com",
							"description": "Email address of the person who needs to receive the invite",
							"type": "text"
						},
						{
							"key": "receiverEmail",
							"value": "piet@company.com",
							"description": "Email address of the person who needs to receive the files. Normaly your own email address",
							"type": "text"
						},
						{
							"key": "notify",
							"value": "true",
							"description": "Optional; When false there will not be send an email from the FileCap server. The 3th party system should handle this.",
							"type": "text",
							"disabled": true
						}
					]
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/invite.jsp",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"invite.jsp"
					]
				},
				"description": "The invite.jsp gives the ability to send FileCap invites to external users.\n\nThe result of this request can be true or false:\n- When the invite was successful, the result will be true.\n- When the invite was unsuccessful, the result will be false with an error message.\n\nThe following text can be in the error message:\n- CANNOT_SEND_MAIL        - The mailserver is not able to process the mail. \n- CANNOT_ADD_INVITE_TO_DB - FileCap was not able to add the invite ID to the DB. \n- UNKNOWN_ERROR           - An exception is raised. Please check the server logs for the full exception."
			},
			"response": []
		},
		{
			"name": "Request mail plugin settings",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"type": "text",
						"value": "application/x-www-form-urlencoded"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "APIKey",
							"value": "HKADASD68768768ASDASDASDAD",
							"description": "The FileCap server API key",
							"type": "text"
						}
					]
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/mailPluginSettings.jsp",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"mailPluginSettings.jsp"
					]
				},
				"description": "mailPluginSettings.jsp can be used to request the FileCap server settings used by the plugins"
			},
			"response": []
		},
		{
			"name": "Request password rules (detailed)",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"value": "application/json",
						"type": "text"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{ \n\t\"apiKey\" : \"HKADASD68768768ASDASDASDAD\",\n\t\"lang\" : \"NL\"\n}"
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/api/settings/getPasswordRules",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"api",
						"settings",
						"getPasswordRules"
					]
				},
				"description": "Request a detailed description of the password requirements set on the FileCap server"
			},
			"response": []
		},
		{
			"name": "Request password rules (short)",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"value": "application/json",
						"type": "text"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{ \n\t\"apiKey\" : \"HKADASD68768768ASDASDASDAD\"\n}"
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/api/settings/getPasswordPolicy",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"api",
						"settings",
						"getPasswordPolicy"
					]
				},
				"description": "Request a short description of the password requirements set on the FileCap server."
			},
			"response": []
		},
		{
			"name": "Check if a file may be send",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"value": "application/x-www-form-urlencoded",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "APIKey",
							"value": "HKADASD68768768ASDASDASDAD",
							"description": "The FileCap server API key",
							"type": "text"
						},
						{
							"key": "filename",
							"value": "test.exe",
							"description": "The filename of the file that needs to be send",
							"type": "text"
						},
						{
							"key": "sender",
							"value": "kees@example.com",
							"description": "The email address of the sender",
							"type": "text"
						},
						{
							"key": "mime",
							"value": "application/exe",
							"description": "The mime type of the filename that needs to be send.",
							"type": "text"
						}
					]
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/checkFile.jsp",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"checkFile.jsp"
					]
				},
				"description": "checkFile.jsp has the ability to verify before sending if a file is allowed to be send."
			},
			"response": []
		},
		{
			"name": "Show files in a transfer",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"value": "application/x-www-form-urlencoded",
						"type": "text"
					}
				],
				"body": {
					"mode": "urlencoded",
					"urlencoded": [
						{
							"key": "APIKey",
							"value": "HKADASD68768768ASDASDASDAD",
							"description": "The FileCap server API key",
							"type": "text"
						},
						{
							"key": "id",
							"value": "263478632784632748237513",
							"description": "The transfer ID",
							"type": "text"
						}
					]
				},
				"url": {
					"raw": "https://filecap.example.com/FileCap/checkTransfer.jsp",
					"protocol": "https",
					"host": [
						"filecap",
						"example",
						"com"
					],
					"path": [
						"FileCap",
						"checkTransfer.jsp"
					]
				}
			},
			"response": []
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"id": "a1850f52-fcb3-4dac-aebd-d956f2372f30",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"id": "8330fac0-7be3-4537-9331-efc157139a01",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"protocolProfileBehavior": {}
}