Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The System Notifications API is used to provide granular controls over who receives email notifications after which type of event.", "version": "1.7.4.1", "title": "Notifications API" }, "tags": [ { "name": "notifications-api", "description": "Notifications API" } ], "definitions": { }, "paths": { "/xapi/notifications": { "get": { "tags": ["notifications-api"], "summary": "Returns the full map of site configuration properties.", "description": "Complex objects may be returned as encapsulated JSON strings.", "operationId": "getNotificationsPropertiesUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Site configuration properties successfully retrieved.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set site configuration properties."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets a map of notifications properties.", "description": "Sets the notifications properties specified in the map.", "operationId": "setNotificationsPropertiesUsingPOST", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "properties", "description": "The map of notifications properties to be set.", "required": true, "schema": { "type": "object", "additionalProperties": {"type": "object"} } }], "responses": { "200": {"description": "Notifications properties successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set notifications properties."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/allow/nonusersubscribers": {"get": { "tags": ["notifications-api"], "summary": "Returns whether non-users should be able to subscribe to notifications.", "description": "This returns whether non-users should be able to subscribe to notifications.", "operationId": "getEmailAllowNonuserSubscribersUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Whether non-users should be able to subscribe to notifications successfully returned.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get whether non-users should be able to subscribe to notifications."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/allow/nonusersubscribers/{setting}": {"post": { "tags": ["notifications-api"], "summary": "Sets whether non-users should be able to subscribe to notifications.", "description": "Sets whether non-users should be able to subscribe to notifications.", "operationId": "setEmailAllowNonuserSubscribersUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "setting", "in": "path", "description": "Whether non-users should be able to subscribe to notifications.", "required": true, "type": "boolean" }], "responses": { "200": { "description": "Whether non-users should be able to subscribe to notifications.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set whether non-users should be able to subscribe to notifications."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/messages/forgotusername": { "get": { "tags": ["notifications-api"], "summary": "Returns the email message for forgot username.", "description": "This returns the email message that people should receive when they click that they forgot their username.", "operationId": "getEmailMessageForgotUsernameRequestUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for forgot username successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for forgot username."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email message for forgot username.", "description": "Sets the email message that people should receive when they click that they forgot their username.", "operationId": "setEmailMessageForgotUsernameRequestUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "message", "in": "query", "description": "The email message for forgot username.", "required": true, "type": "string" }], "responses": { "200": { "description": "Forgot username email message successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the forgot username email message."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/messages/help": { "get": { "tags": ["notifications-api"], "summary": "Returns the email message for contacting help.", "description": "This returns the email message that people should receive when contacting help.", "operationId": "getHelpContactInfoUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for contacting help successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for contacting help."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email message for contacting help.", "description": "Sets the email message that people should receive when contacting help.", "operationId": "setHelpContactInfoUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "message", "in": "query", "description": "The email message for contacting help.", "required": true, "type": "string" }], "responses": { "200": {"description": "Help email message successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the help email message."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/messages/passwordreset": { "get": { "tags": ["notifications-api"], "summary": "Returns the email message for password reset.", "description": "This returns the email message that people should receive when they click to reset their password. Link for password reset is auto-populated.", "operationId": "getEmailMessageForgotPasswordResetUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for password reset successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for password reset."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email message for password reset.", "description": "Sets the email message that people should receive when they click to reset their password. Link for password reset is auto-populated.", "operationId": "setEmailMessageForgotPasswordResetUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "message", "in": "query", "description": "The email message for password reset.", "required": true, "type": "string" }], "responses": { "200": { "description": "Password reset message successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the password reset message."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/messages/registration": { "get": { "tags": ["notifications-api"], "summary": "Returns the email message for user registration.", "description": "This returns the email message that people should receive when they register. Link for email validation is auto-populated.", "operationId": "getEmailMessageUserRegistrationUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for user registration successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for user registration."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email message for user registration.", "description": "Sets the email message that people should receive when they register. Link for email validation is auto-populated.", "operationId": "setEmailMessageUserRegistrationUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "message", "in": "query", "description": "The email message for user registration.", "required": true, "type": "string" }], "responses": { "200": { "description": "User registration email message successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the user registration email message."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/notify/par": { "get": { "tags": ["notifications-api"], "summary": "Returns whether admins should be notified of project access requests.", "description": "This returns whether admins should be notified of project access requests.", "operationId": "getNotifyAdminProjectAccessRequestUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for forgot username successfully returned.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for forgot username."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets whether admins should be notified of project access requests.", "description": "Sets whether admins should be notified of project access requests.", "operationId": "setNotifyAdminProjectAccessRequestUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "notify", "in": "query", "description": "Whether admins should be notified of project access requests successfully set.", "required": true, "type": "boolean" }], "responses": { "200": { "description": "Whether admins should be notified of project access requests successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set whether admins should be notified of project access requests."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/notify/pipeline": { "get": { "tags": ["notifications-api"], "summary": "Returns whether admins should be notified of pipeline processing submit.", "description": "This returns whether admins should be notified of pipeline processing submit.", "operationId": "getNotifyAdminPipelineEmailsUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for user registration successfully returned.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for user registration."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets whether admins should be notified of pipeline processing submit.", "description": "Sets whether admins should be notified of pipeline processing submit.", "operationId": "setNotifyAdminPipelineEmailsUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "notify", "in": "query", "description": "Whether admins should be notified of pipeline processing submit successfully set.", "required": true, "type": "boolean" }], "responses": { "200": { "description": "Whether admins should be notified of pipeline processing submit successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set whether admins should be notified of pipeline processing submit."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/notify/registration": { "get": { "tags": ["notifications-api"], "summary": "Returns whether admins should be notified of user registration.", "description": "This returns whether admins should be notified of user registration.", "operationId": "getNotifyAdminUserRegistrationUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for contacting help successfully returned.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for contacting help."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets whether admins should be notified of user registration.", "description": "Sets whether admins should be notified of user registration.", "operationId": "setNotifyAdminUserRegistrationUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "notify", "in": "query", "description": "Whether admins should be notified of user registration successfully set.", "required": true, "type": "boolean" }], "responses": { "200": {"description": "Whether admins should be notified of user registration successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set whether admins should be notified of user registration."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/notify/transfer": { "get": { "tags": ["notifications-api"], "summary": "Returns whether admins should be notified of session transfer.", "description": "This returns whether admins should be notified of session transfer.", "operationId": "getNotifyAdminSessionTransferUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Email message for password reset successfully returned.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get email message for password reset."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets whether admins should be notified of session transfer.", "description": "Sets whether admins should be notified of session transfer by user.", "operationId": "setNotifyAdminSessionTransferUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "notify", "in": "query", "description": "Whether admins should be notified of session transfer successfully set.", "required": true, "type": "boolean" }], "responses": { "200": { "description": "Whether admins should be notified of session transfer successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set whether admins should be notified of session transfer."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/smtp": { "get": { "tags": ["notifications-api"], "summary": "Returns the full SMTP server configuration.", "description": "Returns the configuration as a map of the standard Java mail sender properties–host, port, protocol, username, and password–along with any extended properties required for the configuration, e.g. configuring SSL- or TLS-secured SMTP services.", "operationId": "getSmtpServerPropertiesUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "SMTP service configuration properties successfully retrieved.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set site configuration properties."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the mail service properties. This return the SMTP server configuration as it exists after being set.", "description": "Sets the mail service host, port, username, password, and protocol. You can set extra properties on the mail sender (e.g. for configuring SSL or TLS transport) by specifying the property name and value. Any parameters submitted that are not one of the standard mail sender attributes is set as a mail sender property. You can remove existing properties by setting the property with an empty value. This will override any existing configuration. You can change the values of properties by calling the API method for that specific property or by calling the PUT version of this method.", "operationId": "setAllMailPropertiesUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "name": "hostname", "in": "query", "description": "The value to set for the email host.", "required": false, "type": "string", "default": "NotSet" }, { "name": "port", "in": "query", "description": "The value to set for the email port.", "required": false, "type": "integer", "default": -1, "format": "int32" }, { "name": "username", "in": "query", "description": "The value to set for the email username.", "required": false, "type": "string", "default": "NotSet" }, { "name": "password", "in": "query", "description": "The value to set for the email password.", "required": false, "type": "string", "default": "NotSet" }, { "name": "protocol", "in": "query", "description": "The value to set for the email protocol.", "required": false, "type": "string", "default": "NotSet" }, { "name": "properties", "in": "query", "description": "Values to set for extra mail properties. An empty value indicates that an existing property should be removed.", "required": false, "type": "ref" } ], "responses": { "200": { "description": "Mail service properties successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service properties."}, "404": {"description": "Not Found"} } }, "put": { "tags": ["notifications-api"], "summary": "Sets the submitted mail service properties. This returns the SMTP server configuration as it exists after being set.", "description": "Sets the mail service host, port, username, password, and protocol. You can set extra properties on the mail sender (e.g. for configuring SSL or TLS transport) by specifying the property name and value. Any parameters submitted that are not one of the standard mail sender attributes is set as a mail sender property. You can remove existing properties by setting the property with an empty value. This will modify the existing server configuration. You can completely replace the configuration by calling the POST version of this method.", "operationId": "setSubmittedMailPropertiesUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "name": "hostname", "in": "query", "description": "The value to set for the email host.", "required": false, "type": "string", "default": "NotSet" }, { "name": "port", "in": "query", "description": "The value to set for the email port.", "required": false, "type": "integer", "default": -1, "format": "int32" }, { "name": "username", "in": "query", "description": "The value to set for the email username.", "required": false, "type": "string", "default": "NotSet" }, { "name": "password", "in": "query", "description": "The value to set for the email password.", "required": false, "type": "string", "default": "NotSet" }, { "name": "protocol", "in": "query", "description": "The value to set for the email protocol.", "required": false, "type": "string", "default": "NotSet" }, { "name": "properties", "in": "query", "description": "Values to set for extra mail properties. An empty value indicates that an existing property should be removed.", "required": false, "type": "ref" } ], "responses": { "200": { "description": "Mail service properties successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service properties."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/smtp/host/{host}": {"put": { "tags": ["notifications-api"], "summary": "Sets the mail service host.", "description": "Sets the mail service host.", "operationId": "setHostPropertyUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "host", "in": "path", "description": "The value to set for the email host.", "required": true, "type": "string" }], "responses": { "200": { "description": "Mail service host successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service host."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/smtp/password/{password}": {"put": { "tags": ["notifications-api"], "summary": "Sets the mail service password.", "description": "Sets the mail service password.", "operationId": "setPasswordPropertyUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "password", "in": "path", "description": "The value to set for the email password.", "required": true, "type": "string" }], "responses": { "200": { "description": "Mail service password successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service password."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/smtp/port/{port}": {"put": { "tags": ["notifications-api"], "summary": "Sets the mail service port.", "description": "Sets the mail service port.", "operationId": "setPortPropertyUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "port", "in": "path", "description": "The value to set for the email port.", "required": true, "type": "integer", "format": "int32" }], "responses": { "200": { "description": "Mail service port successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service port."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/smtp/property/{property}": { "get": { "tags": ["notifications-api"], "summary": "Gets the value for a specified Java mail property.", "description": "The value is always returned as a string.", "operationId": "getExtendedPropertyUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "property", "in": "path", "description": "The mail property to be retrieved.", "required": true, "type": "string" }], "responses": { "200": { "description": "Property found and returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service properties."}, "404": {"description": "Specified key not found in the mail service properties."} } }, "put": { "tags": ["notifications-api"], "summary": "Sets a Java mail property with the submitted name and value.", "description": "Setting a property to an existing value will overwrite the existing value. The value returned by this function contains the previous value (if any).", "operationId": "setExtendedPropertyUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "name": "property", "in": "path", "description": "The name of the extended mail property to set.", "required": true, "type": "string" }, { "in": "body", "name": "value", "description": "The value to set for the extended mail property.", "required": true, "schema": {"type": "string"} } ], "responses": { "200": { "description": "Property found and returned.", "schema": {"type": "string"} }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service properties."}, "404": {"description": "Specified key not found in the mail service properties."} } }, "delete": { "tags": ["notifications-api"], "summary": "Removes the value for a specified Java mail property.", "description": "This completely removes the specified mail property. The value returned by this function contains the previous value (if any).", "operationId": "removeExtendedPropertyUsingDELETE", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "property", "in": "path", "description": "The mail property to be removed.", "required": true, "type": "string" }], "responses": { "200": { "description": "Property found and returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "204": {"description": "No Content"}, "403": {"description": "Not authorized to set the mail service properties."}, "404": {"description": "Specified key not found in the mail service properties."} } } }, "/xapi/notifications/smtp/property/{property}/{value}": {"put": { "tags": ["notifications-api"], "summary": "Sets a Java mail property with the submitted name and value.", "description": "Setting a property to an existing value will overwrite the existing value. The value returned by this function contains the previous value (if any).", "operationId": "setExtendedPropertyFromPathUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "name": "property", "in": "path", "description": "The name of the extended mail property to set.", "required": true, "type": "string" }, { "name": "value", "in": "path", "description": "The value to set for the extended mail property.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Mail service password successfully set.", "schema": {"type": "string"} }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service password."}, "404": {"description": "Specified key not found in the mail service properties."} } }}, "/xapi/notifications/smtp/protocol/{protocol}": {"put": { "tags": ["notifications-api"], "summary": "Sets the mail service protocol.", "description": "Sets the mail service protocol.", "operationId": "setProtocolPropertyUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "protocol", "in": "path", "description": "The value to set for the email protocol.", "required": true, "type": "string" }], "responses": { "200": { "description": "Mail service protocol successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service protocol."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/smtp/username/{username}": {"put": { "tags": ["notifications-api"], "summary": "Sets the mail service username.", "description": "Sets the mail service username.", "operationId": "setUsernamePropertyUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "username", "in": "path", "description": "The value to set for the email username.", "required": true, "type": "string" }], "responses": { "200": { "description": "Mail service username successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the mail service username."}, "404": {"description": "Not Found"} } }}, "/xapi/notifications/subscribers/error": { "get": { "tags": ["notifications-api"], "summary": "Returns list of email addresses subscribed to error notifications.", "description": "This returns a list of all the email addresses that are subscribed to receive error notifications.", "operationId": "getErrorSubscribersUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Error notification subscribers successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get subscribers for email notifications."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email addresses for error notifications.", "description": "Sets the email addresses that should be subscribed to error notifications.", "operationId": "setErrorSubscribersUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "subscribers", "in": "query", "description": "The values to set for email addresses for error notifications.", "required": true, "type": "string" }], "responses": { "200": {"description": "Error subscribers successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the error subscribers."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/subscribers/issue": { "get": { "tags": ["notifications-api"], "summary": "Returns list of email addresses subscribed to issue notifications.", "description": "This returns a list of all the email addresses that are subscribed to receive issue notifications.", "operationId": "getIssueSubscribersUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Issue notification subscribers successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get subscribers for email notifications."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email addresses for issue notifications.", "description": "Sets the email addresses that should be subscribed to issue notifications.", "operationId": "setIssueSubscribersUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "subscribers", "in": "query", "description": "The values to set for email addresses for issue notifications.", "required": true, "type": "string" }], "responses": { "200": { "description": "Issue subscribers successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the issue subscribers."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/subscribers/newuser": { "get": { "tags": ["notifications-api"], "summary": "Returns list of email addresses subscribed to new user notifications.", "description": "This returns a list of all the email addresses that are subscribed to receive new user notifications.", "operationId": "getNewUserSubscribersUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "New user notification subscribers successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get subscribers for email notifications."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email addresses for new user notifications.", "description": "Sets the email addresses that should be subscribed to new user notifications.", "operationId": "setNewUserSubscribersUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "subscribers", "in": "query", "description": "The values to set for email addresses for new user notifications.", "required": true, "type": "string" }], "responses": { "200": { "description": "New user subscribers successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the new user subscribers."}, "404": {"description": "Not Found"} } } }, "/xapi/notifications/subscribers/update": { "get": { "tags": ["notifications-api"], "summary": "Returns list of email addresses subscribed to update notifications.", "description": "This returns a list of all the email addresses that are subscribed to receive update notifications.", "operationId": "getUpdateSubscribersUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Update notification subscribers successfully returned.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to get subscribers for email notifications."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["notifications-api"], "summary": "Sets the email addresses for update notifications.", "description": "Sets the email addresses that should be subscribed to update notifications.", "operationId": "setUpdateSubscribersUsingPOST", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "subscribers", "in": "query", "description": "The values to set for email addresses for update notifications.", "required": true, "type": "string" }], "responses": { "200": { "description": "Update subscribers successfully set.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set the update subscribers."}, "404": {"description": "Not Found"} } } }, } }
  • No labels