{ "swagger": "2.0", "info": { "contact": { "email": "eHbox@smals.be", "name": "eHbox team" }, "description": "Ebox Restful API", "license": { "name": "Apache Licence Version 2.0" }, "title": "EBox High Capacity", "version": "1.0" }, "host": "api.ehealth.fgov.be", "basePath": "/ehboxAPI", "schemes": [ "https" ], "paths": { "/mailboxes": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "identifiers", "in": "body", "name": "body", "required": false, "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } ], "responses": { "200": { "description": "Succeed", "schema": { "$ref": "#/definitions/MailboxAccessKey" } }, "400": { "description": "Box identifier invalid", "schema": { "$ref": "#/definitions/EboxProblem" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "409": { "description": "Box already exists" } }, "tags": [ "Mailbox" ], "deprecated": false, "operationId": "CreateMailboxIfNotExists", "summary": "Create mailbox if not exist", "x-codegen-request-body-name": "identifiers" } }, "/mailboxes/{accessKey}": { "get": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" } ], "responses": { "200": { "description": "Succeed", "schema": { "$ref": "#/definitions/Mailbox" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Mailbox" ], "deprecated": false, "operationId": "GetMailbox", "summary": "Consult informations from a mailbox" }, "patch": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "mailboxPatch", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/MailboxPatch" } } ], "responses": { "204": { "description": "Update succeed" }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Mailbox" ], "deprecated": false, "operationId": "UpdateMailbox", "summary": "Update notification settings of mailbox", "x-codegen-request-body-name": "mailboxPatch" } }, "/mailboxes/{accessKey}/folders": { "get": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" } ], "responses": { "200": { "description": "Succeed", "schema": { "$ref": "#/definitions/CollectionContainerOfMailboxFolderContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Folder" ], "deprecated": false, "operationId": "ListMailboxFolder", "summary": "List folders of mailboxes" } }, "/mailboxes/{accessKey}/folders/bin/messages/recover": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "idContainer", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/IdContainerOfstring" } } ], "responses": { "200": { "description": "Untrash of messages succeed but with some failed id's", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "204": { "description": "Untrash of messages succeed", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "RecoverMessagesFromBinbox", "summary": "Post a recovery on messages to recover them to their inbox", "x-codegen-request-body-name": "idContainer" } }, "/mailboxes/{accessKey}/folders/binsent/messages/recover": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "idContainer", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/IdContainerOfstring" } } ], "responses": { "200": { "description": "Untrash of messages succeed but with some failed id's", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "204": { "description": "Untrash of messages succeed", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "RecoverMessagesFromBinSentbox", "summary": "Post a recovery on messages to recover them to their sentBox", "x-codegen-request-body-name": "idContainer" } }, "/mailboxes/{accessKey}/folders/in/messages/trash": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "idContainer", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/IdContainerOfstring" } } ], "responses": { "200": { "description": "Trash of messages succeed but with some failed id's", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "204": { "description": "Trash of messages succeed", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "TrashMessagesFromInbox", "summary": "Post a trash on messages to move them from inbox to binbox", "x-codegen-request-body-name": "idContainer" } }, "/mailboxes/{accessKey}/folders/sent/messages/trash": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "idContainer", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/IdContainerOfstring" } } ], "responses": { "200": { "description": "Trash of messages succeed but with some failed id's", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "204": { "description": "Trash of messages succeed", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "TrashMessagesFromSentbox", "summary": "Post a trash on messages to move them from sentbox to binsentbox", "x-codegen-request-body-name": "idContainer" } }, "/mailboxes/{accessKey}/folders/{folder}/messages": { "get": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "folder", "in": "path", "name": "folder", "required": true, "type": "string" }, { "default": false, "description": "hasAnnex", "in": "query", "name": "hasAnnex", "type": "boolean" }, { "default": false, "description": "important", "in": "query", "name": "important", "type": "boolean" }, { "description": "messageType", "in": "query", "name": "messageType", "type": "string" }, { "default": 1, "description": "page", "exclusiveMinimum": false, "format": "int32", "in": "query", "minimum": 1, "name": "page", "type": "integer" }, { "default": 100, "description": "pageSize", "exclusiveMaximum": false, "exclusiveMinimum": false, "format": "int32", "in": "query", "maximum": 100, "minimum": 0, "name": "pageSize", "type": "integer" }, { "description": "q", "in": "query", "name": "q", "type": "string" }, { "description": "since", "in": "query", "name": "since", "type": "string" }, { "default": false, "description": "unread", "in": "query", "name": "unread", "type": "boolean" } ], "responses": { "200": { "description": "Succeed", "schema": { "$ref": "#/definitions/PageOfMessages" } }, "400": { "description": "Folder value invalid" }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists" } }, "tags": [ "Message" ], "deprecated": false, "operationId": "ListMessages", "summary": "List messages from mailbox's folder" } }, "/mailboxes/{accessKey}/folders/{folder}/messages/delete": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "folder", "in": "path", "name": "folder", "required": true, "type": "string" }, { "description": "idContainer", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/IdContainerOflong" } } ], "responses": { "200": { "description": "Removal of messages succeed but with some failed id's", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "204": { "description": "Removal of messages succeed", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "DeleteMultipleMessages", "summary": "Post a request to delete multiple messages", "x-codegen-request-body-name": "idContainer" } }, "/mailboxes/{accessKey}/folders/{folder}/messages/{messageId}": { "delete": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "folder", "in": "path", "name": "folder", "required": true, "type": "string" }, { "description": "messageId", "format": "int64", "in": "path", "name": "messageId", "required": true, "type": "integer" } ], "responses": { "204": { "description": "Removal of messages succeed" }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "DeleteOneMessage", "summary": "Delete one message" }, "get": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "folder", "in": "path", "name": "folder", "required": true, "type": "string" }, { "description": "messageId", "format": "int64", "in": "path", "name": "messageId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Succeed", "schema": { "$ref": "#/definitions/Message" } }, "400": { "description": "Folder value invalid", "schema": { "$ref": "#/definitions/EboxProblem" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "GetMessage", "summary": "Load a full message" } }, "/mailboxes/{accessKey}/folders/{folder}/messages/{messageId}/attachments/{attachmentKey}": { "get": { "produces": [ "application/octet-stream", "application/problem+json;charset=UTF-8" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "attachmentKey", "in": "path", "name": "attachmentKey", "required": true, "type": "string" }, { "description": "folder", "in": "path", "name": "folder", "required": true, "type": "string" }, { "description": "messageId", "format": "int64", "in": "path", "name": "messageId", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Succeed", "schema": { "$ref": "#/definitions/Resource" } }, "400": { "description": "Folder value invalid", "schema": { "$ref": "#/definitions/EboxProblem" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists" } }, "tags": [ "Attachment" ], "deprecated": false, "operationId": "GetAttachment", "summary": "Load an attachment by id" } }, "/mailboxes/{accessKey}/outOfOffices": { "post": { "consumes": [ "application/json;charset=UTF-8", "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "outOfOffice", "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/OutOfOffice" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OutOfOfficeResponse" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/OutOfOfficeResponse" } }, "400": { "description": "Out of office invalid", "schema": { "$ref": "#/definitions/EboxProblem" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exist" } }, "tags": [ "OutOfOffice" ], "deprecated": false, "operationId": "CreateOutOfOffice", "summary": "Create an outOfOffice for a specific mailbox", "x-codegen-request-body-name": "outOfOffice" } }, "/mailboxes/{accessKey}/outOfOffices/{id}": { "delete": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "204": { "description": "Removal of outOfOffice succeeds" }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Out of office doesn't exist", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "OutOfOffice" ], "deprecated": false, "operationId": "DeleteOutOfOffice", "summary": "Delete an outOfOffice" } }, "/mailboxes/{accessKey}/publications": { "post": { "consumes": [ "multipart/form-data" ], "produces": [ "application/json;charset=UTF-8", "application/problem+json;charset=UTF-8" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "in": "formData", "name": "body", "required": true } ], "responses": { "202": { "description": "Publication is in progress", "schema": { "$ref": "#/definitions/PublicationTask" } }, "400": { "description": "Folder value invalid", "schema": { "$ref": "#/definitions/EboxProblem" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Mailbox not exists", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "PublishMessage", "summary": "Publish a new message" } }, "/mailboxes/{accessKey}/publications/{id}": { "get": { "produces": [ "application/json;charset=UTF-8", "application/problem+json" ], "parameters": [ { "description": "accessKey", "in": "path", "name": "accessKey", "required": true, "type": "string" }, { "description": "id", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Recover succeed", "schema": { "$ref": "#/definitions/CollectionContainer" } }, "401": { "description": "The requester is unauthorized.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "403": { "description": "The request is forbidden.", "schema": { "$ref": "#/definitions/EboxProblem" } }, "404": { "description": "Publication not found", "schema": { "$ref": "#/definitions/EboxProblem" } } }, "tags": [ "Message" ], "deprecated": false, "operationId": "RecoverPublicationState", "summary": "Recover the publication state" } } }, "definitions": { "AcknowledgeStatus": { "properties": { "publishDateTime": { "type": "string" }, "readDateTime": { "type": "string" }, "recipient": { "$ref": "#/definitions/Recipient" }, "viewDateTime": { "type": "string" } }, "title": "AcknowledgeStatus", "type": "object" }, "Acknowledgements": { "example": { "read": true, "sent": true, "viewed": true }, "properties": { "read": { "type": "boolean" }, "sent": { "type": "boolean" }, "viewed": { "type": "boolean" } }, "title": "Acknowledgements", "type": "object" }, "ActorInfo": { "example": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "organization": { "type": "boolean" }, "organizationName": { "type": "string" }, "ssin": { "type": "string" }, "user": { "type": "boolean" } }, "title": "ActorInfo", "type": "object" }, "Annex": { "example": { "annexKey": "annexKey", "fileName": "fileName", "primary": true }, "properties": { "annexKey": { "type": "string" }, "fileName": { "type": "string" }, "primary": { "type": "boolean" } }, "title": "Annex", "type": "object" }, "AnnexMetadata": { "example": { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" }, "properties": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "contentType": { "type": "string" }, "digest": { "type": "string" }, "fileName": { "type": "string" }, "primary": { "type": "boolean" }, "title": { "type": "string" } }, "required": [ "fileName", "title" ], "title": "AnnexMetadata", "type": "object" }, "CollectionContainer": { "example": { "items": [ "{}", "{}" ], "total": 0 }, "properties": { "items": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "total": { "format": "int32", "type": "integer" } }, "title": "CollectionContainer", "type": "object" }, "CollectionContainerOfAcknowledgeStatus": { "properties": { "items": { "items": { "$ref": "#/definitions/AcknowledgeStatus" }, "type": "array" }, "total": { "format": "int32", "type": "integer" } }, "title": "CollectionContainerOfAcknowledgeStatus", "type": "object" }, "CollectionContainerOfMailboxFolderContainer": { "example": { "items": [ { "deletable": true, "recoverable": true, "trash": true, "value": "value" }, { "deletable": true, "recoverable": true, "trash": true, "value": "value" } ], "total": 0 }, "properties": { "items": { "items": { "$ref": "#/definitions/MailboxFolderContainer" }, "type": "array" }, "total": { "format": "int32", "type": "integer" } }, "title": "CollectionContainerOfMailboxFolderContainer", "type": "object" }, "EboxProblem": { "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "status": { "$ref": "#/definitions/StatusType" }, "title": { "type": "string" }, "type": { "type": "string" } }, "title": "EboxProblem", "type": "object" }, "File": { "properties": { "absolute": { "type": "boolean" }, "absoluteFile": { "$ref": "#/definitions/File" }, "absolutePath": { "type": "string" }, "canonicalFile": { "$ref": "#/definitions/File" }, "canonicalPath": { "type": "string" }, "directory": { "type": "boolean" }, "executable": { "type": "boolean" }, "file": { "type": "boolean" }, "freeSpace": { "format": "int64", "type": "integer" }, "hidden": { "type": "boolean" }, "lastModified": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "parent": { "type": "string" }, "parentFile": { "$ref": "#/definitions/File" }, "path": { "type": "string" }, "readable": { "type": "boolean" }, "totalSpace": { "format": "int64", "type": "integer" }, "usableSpace": { "format": "int64", "type": "integer" }, "writable": { "type": "boolean" } }, "title": "File", "type": "object" }, "IdContainerOflong": { "example": { "ids": [ 0, 0 ] }, "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "title": "IdContainerOflong", "type": "object" }, "IdContainerOfstring": { "example": { "ids": [ "ids", "ids" ] }, "properties": { "ids": { "items": { "type": "string" }, "type": "array" } }, "title": "IdContainerOfstring", "type": "object" }, "InputStream": { "title": "InputStream", "type": "object" }, "Mailbox": { "example": { "accessKey": { "key": "key", "mailboxIdentifier": { "boxIdentifiers": { "key": "boxIdentifiers" } } }, "actor": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "creationTms": "2019-01-01T01:00:00.000000", "currentSize": 0, "lastAccessTms": "2019-01-01T01:00:00.000000", "notificationEnabled": true, "outOfOffices": { "key": { "endDate": "2000-01-23", "startDate": "2000-01-23", "substitutes": [ null, null ] } }, "quota": 6, "standbyMessagesCount": 1, "unreadMessagesCount": 5 }, "properties": { "accessKey": { "$ref": "#/definitions/MailboxAccessKey" }, "actor": { "$ref": "#/definitions/ActorInfo" }, "creationTms": { "example": "2019-01-01T01:00:00.000000", "type": "string" }, "currentSize": { "format": "int64", "type": "integer" }, "lastAccessTms": { "example": "2019-01-01T01:00:00.000000", "type": "string" }, "notificationEnabled": { "type": "boolean" }, "outOfOffices": { "additionalProperties": { "$ref": "#/definitions/OutOfOffice" }, "type": "object" }, "quota": { "format": "int64", "type": "integer" }, "standbyMessagesCount": { "format": "int32", "type": "integer" }, "unreadMessagesCount": { "format": "int32", "type": "integer" } }, "title": "Mailbox", "type": "object" }, "MailboxAccessKey": { "example": { "key": "key", "mailboxIdentifier": { "boxIdentifiers": { "key": "boxIdentifiers" } } }, "properties": { "key": { "type": "string" }, "mailboxIdentifier": { "$ref": "#/definitions/MailboxIdentifier" } }, "title": "MailboxAccessKey", "type": "object" }, "MailboxFolderContainer": { "example": { "deletable": true, "recoverable": true, "trash": true, "value": "value" }, "properties": { "deletable": { "type": "boolean" }, "recoverable": { "type": "boolean" }, "trash": { "type": "boolean" }, "value": { "type": "string" } }, "title": "MailboxFolderContainer", "type": "object" }, "MailboxIdentifier": { "example": { "boxIdentifiers": { "key": "boxIdentifiers" } }, "properties": { "boxIdentifiers": { "additionalProperties": { "type": "string" }, "type": "object" } }, "title": "MailboxIdentifier", "type": "object" }, "MailboxPatch": { "example": { "email": "email", "notificationEnabled": true }, "properties": { "email": { "type": "string" }, "notificationEnabled": { "type": "boolean" } }, "title": "MailboxPatch", "type": "object" }, "MapOfstringAndstring": { "additionalProperties": { "type": "string" }, "title": "MapOfstringAndstring", "type": "object" }, "Message": { "example": { "content": { "annexes": [ { "annexKey": "annexKey", "fileName": "fileName", "primary": true }, { "annexKey": "annexKey", "fileName": "fileName", "primary": true } ], "expirationBinDate": "2000-01-23", "expirationDate": "2000-01-23", "identifier": 0, "original": { "acknowledgements": { "read": true, "sent": true, "viewed": true }, "annexesMetadata": [ { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" }, { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" } ], "encrypted": true, "extensions": "{}", "important": true, "metadata": { "key": "metadata" }, "payload": "payload", "payloadMimetype": "payloadMimetype", "publicationId": "publicationId", "recipients": [ { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } } ], "title": "title", "type": "DOCUMENT" }, "publicationDateTime": "2019-01-01T01:00:00.000000", "recipient": { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, "sender": { "actor": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "identifiers": { "key": "identifiers" } }, "senderAccessKey": "senderAccessKey", "size": 6 }, "metadata": { "readDateTime": "2019-01-01T01:00:00.000000", "viewDateTime": "2019-01-01T01:00:00.000000" } }, "properties": { "content": { "$ref": "#/definitions/MessageContent" }, "metadata": { "$ref": "#/definitions/Metadata" } }, "title": "Message", "type": "object" }, "MessageContent": { "example": { "annexes": [ { "annexKey": "annexKey", "fileName": "fileName", "primary": true }, { "annexKey": "annexKey", "fileName": "fileName", "primary": true } ], "expirationBinDate": "2000-01-23", "expirationDate": "2000-01-23", "identifier": 0, "original": { "acknowledgements": { "read": true, "sent": true, "viewed": true }, "annexesMetadata": [ { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" }, { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" } ], "encrypted": true, "extensions": "{}", "important": true, "metadata": { "key": "metadata" }, "payload": "payload", "payloadMimetype": "payloadMimetype", "publicationId": "publicationId", "recipients": [ { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } } ], "title": "title", "type": "DOCUMENT" }, "publicationDateTime": "2019-01-01T01:00:00.000000", "recipient": { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, "sender": { "actor": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "identifiers": { "key": "identifiers" } }, "senderAccessKey": "senderAccessKey", "size": 6 }, "properties": { "annexes": { "items": { "$ref": "#/definitions/Annex" }, "type": "array" }, "expirationBinDate": { "format": "date", "type": "string" }, "expirationDate": { "format": "date", "type": "string" }, "identifier": { "format": "int64", "type": "integer" }, "original": { "$ref": "#/definitions/PublishedMessage" }, "publicationDateTime": { "example": "2019-01-01T01:00:00.000000", "type": "string" }, "recipient": { "$ref": "#/definitions/Recipient" }, "sender": { "$ref": "#/definitions/Sender" }, "senderAccessKey": { "type": "string" }, "size": { "format": "int64", "type": "integer" } }, "title": "MessageContent", "type": "object" }, "Metadata": { "example": { "readDateTime": "2019-01-01T01:00:00.000000", "viewDateTime": "2019-01-01T01:00:00.000000" }, "properties": { "readDateTime": { "example": "2019-01-01T01:00:00.000000", "type": "string" }, "viewDateTime": { "example": "2019-01-01T01:00:00.000000", "type": "string" } }, "title": "Metadata", "type": "object" }, "OutOfOffice": { "example": { "endDate": "2000-01-23", "startDate": "2000-01-23", "substitutes": [ null, null ] }, "properties": { "endDate": { "format": "date", "type": "string" }, "startDate": { "format": "date", "type": "string" }, "substitutes": { "items": { "$ref": "#/definitions/MapOfstringAndstring" }, "type": "array" } }, "title": "OutOfOffice", "type": "object" }, "OutOfOfficeResponse": { "example": { "errorCode": "errorCode", "outOfOfficeId": "outOfOfficeId", "substitutesInError": [ { "identifiers": { "key": "identifiers" }, "linkedErrorCodeValue": "linkedErrorCodeValue", "outOfOfficeEndDate": "2000-01-23", "outOfOfficeStartDate": "2000-01-23" }, { "identifiers": { "key": "identifiers" }, "linkedErrorCodeValue": "linkedErrorCodeValue", "outOfOfficeEndDate": "2000-01-23", "outOfOfficeStartDate": "2000-01-23" } ], "success": true }, "properties": { "errorCode": { "type": "string" }, "outOfOfficeId": { "type": "string" }, "substitutesInError": { "items": { "$ref": "#/definitions/SubstituteInError" }, "type": "array" }, "success": { "type": "boolean" } }, "title": "OutOfOfficeResponse", "type": "object" }, "PageOfMessages": { "example": { "items": [ { "content": { "annexes": [ { "annexKey": "annexKey", "fileName": "fileName", "primary": true }, { "annexKey": "annexKey", "fileName": "fileName", "primary": true } ], "expirationBinDate": "2000-01-23", "expirationDate": "2000-01-23", "identifier": 0, "original": { "acknowledgements": { "read": true, "sent": true, "viewed": true }, "annexesMetadata": [ { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" }, { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" } ], "encrypted": true, "extensions": "{}", "important": true, "metadata": { "key": "metadata" }, "payload": "payload", "payloadMimetype": "payloadMimetype", "publicationId": "publicationId", "recipients": [ { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } } ], "title": "title", "type": "DOCUMENT" }, "publicationDateTime": "2019-01-01T01:00:00.000000", "recipient": { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, "sender": { "actor": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "identifiers": { "key": "identifiers" } }, "senderAccessKey": "senderAccessKey", "size": 6 }, "metadata": { "readDateTime": "2019-01-01T01:00:00.000000", "viewDateTime": "2019-01-01T01:00:00.000000" } }, { "content": { "annexes": [ { "annexKey": "annexKey", "fileName": "fileName", "primary": true }, { "annexKey": "annexKey", "fileName": "fileName", "primary": true } ], "expirationBinDate": "2000-01-23", "expirationDate": "2000-01-23", "identifier": 0, "original": { "acknowledgements": { "read": true, "sent": true, "viewed": true }, "annexesMetadata": [ { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" }, { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" } ], "encrypted": true, "extensions": "{}", "important": true, "metadata": { "key": "metadata" }, "payload": "payload", "payloadMimetype": "payloadMimetype", "publicationId": "publicationId", "recipients": [ { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } } ], "title": "title", "type": "DOCUMENT" }, "publicationDateTime": "2019-01-01T01:00:00.000000", "recipient": { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, "sender": { "actor": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "identifiers": { "key": "identifiers" } }, "senderAccessKey": "senderAccessKey", "size": 6 }, "metadata": { "readDateTime": "2019-01-01T01:00:00.000000", "viewDateTime": "2019-01-01T01:00:00.000000" } } ], "page": 1, "pageSize": 5, "total": 5 }, "properties": { "items": { "items": { "$ref": "#/definitions/Message" }, "type": "array" }, "page": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "total": { "format": "int32", "type": "integer" } }, "title": "PageOfMessages", "type": "object" }, "Person": { "example": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" }, "properties": { "firstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "ssin": { "type": "string" } }, "required": [ "firstName", "lastName", "ssin" ], "title": "Person", "type": "object" }, "PublicationTask": { "example": { "href": "href", "messageId": 0, "publicationId": "publicationId" }, "properties": { "href": { "type": "string" }, "messageId": { "format": "int64", "type": "integer" }, "publicationId": { "type": "string" } }, "title": "PublicationTask", "type": "object" }, "PublishedMessage": { "example": { "acknowledgements": { "read": true, "sent": true, "viewed": true }, "annexesMetadata": [ { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" }, { "additionalProperties": { "key": "additionalProperties" }, "contentType": "contentType", "digest": "digest", "fileName": "fileName", "primary": true, "title": "title" } ], "encrypted": true, "extensions": "{}", "important": true, "metadata": { "key": "metadata" }, "payload": "payload", "payloadMimetype": "payloadMimetype", "publicationId": "publicationId", "recipients": [ { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } } ], "title": "title", "type": "DOCUMENT" }, "properties": { "acknowledgements": { "$ref": "#/definitions/Acknowledgements" }, "annexesMetadata": { "items": { "$ref": "#/definitions/AnnexMetadata" }, "type": "array" }, "encrypted": { "type": "boolean" }, "extensions": { "properties": {}, "type": "object" }, "important": { "type": "boolean" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "payload": { "type": "string" }, "payloadMimetype": { "maxLength": 10, "type": "string" }, "publicationId": { "maxLength": 13, "minLength": 1, "type": "string" }, "recipients": { "items": { "$ref": "#/definitions/Recipient" }, "type": "array" }, "title": { "maxLength": 400, "minLength": 1, "type": "string" }, "type": { "enum": [ "ACKNOWLEDGMENT", "DOCUMENT", "ERROR", "NEWS" ], "example": "DOCUMENT", "type": "string" } }, "required": [ "recipients", "title" ], "title": "PublishedMessage", "type": "object" }, "Recipient": { "description": "Recipient of a message", "example": { "identifiers": { "key": "identifiers" }, "outOfOfficeIgnored": true, "person": { "firstName": "firstName", "lastName": "lastName", "ssin": "ssin" } }, "properties": { "identifiers": { "additionalProperties": { "type": "string" }, "type": "object" }, "outOfOfficeIgnored": { "type": "boolean" }, "person": { "$ref": "#/definitions/Person" } }, "required": [ "identifiers" ], "title": "Recipient", "type": "object" }, "Resource": { "properties": { "description": { "type": "string" }, "file": { "$ref": "#/definitions/File" }, "filename": { "type": "string" }, "inputStream": { "title": "InputStream", "type": "object" }, "open": { "type": "boolean" }, "readable": { "type": "boolean" }, "uri": { "type": "string" }, "url": { "$ref": "#/definitions/URL" } }, "title": "Resource", "type": "object" }, "Sender": { "example": { "actor": { "email": "email", "firstName": "firstName", "lastName": "lastName", "organization": true, "organizationName": "organizationName", "ssin": "ssin", "user": true }, "identifiers": { "key": "identifiers" } }, "properties": { "actor": { "$ref": "#/definitions/ActorInfo" }, "identifiers": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "identifiers" ], "title": "Sender", "type": "object" }, "StatusType": { "properties": { "reasonPhrase": { "type": "string" }, "statusCode": { "format": "int32", "type": "integer" } }, "title": "StatusType", "type": "object" }, "SubstituteInError": { "example": { "identifiers": { "key": "identifiers" }, "linkedErrorCodeValue": "linkedErrorCodeValue", "outOfOfficeEndDate": "2000-01-23", "outOfOfficeStartDate": "2000-01-23" }, "properties": { "identifiers": { "additionalProperties": { "type": "string" }, "type": "object" }, "linkedErrorCodeValue": { "type": "string" }, "outOfOfficeEndDate": { "format": "date", "type": "string" }, "outOfOfficeStartDate": { "format": "date", "type": "string" } }, "title": "SubstituteInError", "type": "object" }, "URL": { "properties": { "host": { "type": "string" }, "authority": { "type": "string" }, "content": { "properties": {}, "type": "object" }, "defaultPort": { "format": "int32", "type": "integer" }, "deserializedFields": { "title": "URLStreamHandler", "type": "object" }, "file": { "type": "string" }, "path": { "type": "string" }, "port": { "format": "int32", "type": "integer" }, "protocol": { "type": "string" }, "query": { "type": "string" }, "ref": { "type": "string" }, "serializedHashCode": { "format": "int32", "type": "integer" }, "userInfo": { "type": "string" } }, "title": "URL", "type": "object" }, "URLStreamHandler": { "title": "URLStreamHandler", "type": "object" } }, "securityDefinitions": { "OAuth2": { "authorizationUrl": "https://api.ehealth.fgov.be/auth/realms/healthcare/protocol/openid-connect/auth", "flow": "accessCode", "scopes": { "user": "Allows all operations on service" }, "tokenUrl": "https://api.ehealth.fgov.be/auth/realms/healthcare/protocol/openid-connect/token", "type": "oauth2" } }, "security": [ { "OAuth2": [ "user" ] } ], "x-components": { "responses": { "Forbidden": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/definitions/EboxProblem" } }, "application/problem+json": { "schema": { "$ref": "#/definitions/EboxProblem" } } }, "description": "The request is forbidden." }, "NotAuthorized": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/definitions/EboxProblem" } }, "application/problem+json": { "schema": { "$ref": "#/definitions/EboxProblem" } } }, "description": "The requester is unauthorized." } } } }