### Get Commands for Installed Market Place Applications (OpenAPI) Source: https://developers.nexudus.com/reference/commands-installedmarketplaceapplication This OpenAPI definition snippet details the endpoint for retrieving commands available for Installed Market Place Applications. It specifies the request method (GET), parameters like 'id' for filtering, and the structure of the 200 OK response, which includes command details such as Key, Name, and required parameters. ```json { "openapi": "3.1.0", "info": { "title": "nexudus-rest-api", "version": "1.0" }, "servers": [ { "url": "https://spaces.nexudus.com/api" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/apps/installedmarketplaceapplications/commands": { "get": { "summary": "Commands for InstalledMarketPlaceApplications", "description": "This endpoint lets you get the list of available commands for Installed Market Place Application records.", "operationId": "commands-installedmarketplaceapplication", "parameters": [ { "name": "id", "in": "query", "description": "If provided, only commands available for this Installed Market Place Application will be returned.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[ { "Key":"COMMAND_KEY_1", "Name":"Command name", "AppliesOnlyToMultipleEntities":false, "DisplayInDropdown":false, "DisplayInDropdownV2":true, "AppliesOnlyToOneEntity":true, "AppliesOnlyToTwoEntities":false, "DisplayInGrid":false, "Icon":"/Content/Themes/Admin/Images/Icons/Fugue/gear.png", "NeedsEntitiesToRun":true, "Order":8, "RequiresParameters":[ { "Name":"Parameter name", "Type":"parameterType" } ] } ]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "Key": { "type": "string", "example": "COMMAND_KEY_1" }, "Name": { "type": "string", "example": "Command name" }, "AppliesOnlyToMultipleEntities": { "type": "boolean", "example": false, "default": true }, "DisplayInDropdown": { "type": "boolean", "example": false, "default": true }, "DisplayInDropdownV2": { "type": "boolean", "example": true, "default": true }, "AppliesOnlyToOneEntity": { "type": "boolean", "example": true, "default": true }, "AppliesOnlyToTwoEntities": { "type": "boolean", "example": false, "default": true }, "DisplayInGrid": { "type": "boolean", "example": false, "default": true }, "Icon": { "type": "string", "example": "/Content/Themes/Admin/Images/Icons/Fugue/gear.png" }, "NeedsEntitiesToRun": { "type": "boolean", "example": true, "default": true }, "Order": { "type": "integer", "example": 8, "default": 0 }, "RequiresParameters": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "example": "Parameter name" }, "Type": { "type": "string", "example": "parameterType" } } } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [] } } ``` -------------------------------- ### Get NEXUDUS App Installations (OpenAPI) Source: https://developers.nexudus.com/reference/installations Defines the API endpoint to retrieve information about all locations where a specific marketplace application has been installed. It requires a `marketplace_id` and returns a list of installations with details like location name, ID, and feature enablement status. The response includes example data and schema definitions. ```json { "openapi": "3.1.0", "info": { "title": "nexudus-rest-api", "version": "1.0" }, "servers": [ { "url": "https://spaces.nexudus.com/api" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/apps/marketplaceApplications/installations": { "get": { "summary": "✅Installations", "description": "Gets information about all the locations which enabled your marketplace application", "operationId": "installations", "parameters": [ { "name": "marketplace_id", "in": "query", "description": "The unique id of your marketplace application.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[ { "location_name": "Central Coworks", "location_id": "d4cb499b-ec2c-4208-ae9f-3699ed4e210e", "accept_bookings": false, "accept_event_signups": false, "accept_payment_requests": false, "provide_resource_rrices": false, "provide_resources": false, "provide_events": false, "provide_products": false, "provide_tariffs": false, "calendar_url": "https://spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e", "feed_url": "https://spaces.nexudus.com/api/apps/marketplaceapplications/feed?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e" } ]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "location_name": { "type": "string", "example": "Central Coworks" }, "location_id": { "type": "string", "example": "d4cb499b-ec2c-4208-ae9f-3699ed4e210e" }, "accept_bookings": { "type": "boolean", "example": false, "default": true }, "accept_event_signups": { "type": "boolean", "example": false, "default": true }, "accept_payment_requests": { "type": "boolean", "example": false, "default": true }, "provide_resource_rrices": { "type": "boolean", "example": false, "default": true }, "provide_resources": { "type": "boolean", "example": false, "default": true }, "provide_events": { "type": "boolean", "example": false, "default": true }, "provide_products": { "type": "boolean", "example": false, "default": true }, "provide_tariffs": { "type": "boolean", "example": false, "default": true }, "calendar_url": { "type": "string", "example": "https://spaces.nexudus.com/api/apps/marketplaceapplications/calendar?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e" }, "feed_url": { "type": "string", "example": "https://spaces.nexudus.com/api/apps/marketplaceapplications/feed?marketplace_id=78d4f2ac-e3a1-42ef-9158-b7df3c765ada&location_id=d4cb499b-ec2c-4208-ae9f-3699ed4e210e" } } } } } } }, "401": { "description": "401", "content": { "application/json": {} } } } } } } } ``` -------------------------------- ### POST /example Source: https://developers.nexudus.com/reference/add-resource This endpoint allows for the creation of a new example resource. It accepts a JSON payload with resource details and returns the status of the operation. ```APIDOC ## POST /example ### Description This endpoint allows for the creation of a new example resource. It accepts a JSON payload with resource details and returns the status of the operation. ### Method POST ### Endpoint /example ### Request Body - **PictureFileName** (string) - Description - **SystemId** (string) - Description ### Request Example ```json { "PictureFileName": "example.jpg", "SystemId": "sys123" } ``` ### Response #### Success Response (200) - **Status** (integer) - The status code of the operation. - **Message** (string) - A message indicating the result of the operation. - **Value** (object) - Contains the ID of the created resource. - **Id** (integer) - The unique identifier of the created resource. - **RedirectURL** (object) - URL for redirection, if applicable. - **UpdatedOn** (string) - The date and time when the resource was last updated. - **UpdatedBy** (string) - The email address of the user who last updated the resource. - **Errors** (object) - Contains any errors encountered during the operation. - **WasSuccessful** (boolean) - A flag indicating whether the operation was successful. #### Response Example (200) ```json { "Status": 200, "Message": "Resource \"Example\" was successfully created.", "Value": { "Id": 10605 }, "RedirectURL": null, "UpdatedOn": "2021-04-15T12:19:07Z", "UpdatedBy": "john@example.com", "Errors": null, "WasSuccessful": true } ``` #### Error Response (400) - **Status** (integer) - The status code of the error. - **Message** (string) - A message describing the error. - **Value** (object) - Typically null for errors. - **RedirectURL** (object) - Typically null for errors. - **UpdatedOn** (object) - Typically null for errors. - **UpdatedBy** (object) - Typically null for errors. - **Errors** (array) - A list of errors encountered. - **AttemptedValue** (string) - The value that caused the error. - **Message** (string) - A detailed message about the error. - **PropertyName** (string) - The name of the property that caused the error. - **WasSuccessful** (boolean) - False, indicating the operation failed. #### Response Example (400) ```json { "Status": 500, "Message": "Name: may not be null or empty", "Value": null, "RedirectURL": null, "UpdatedOn": null, "UpdatedBy": null, "Errors": [ { "AttemptedValue": "", "Message": "may not be null or empty", "PropertyName": "Name" } ], "WasSuccessful": false } ``` ``` -------------------------------- ### OpenAPI Definition for Get Installed Marketplace Application Source: https://developers.nexudus.com/reference/get-installedmarketplaceapplication This OpenAPI 3.1.0 definition outlines the GET request for retrieving a single Installed Market Place Application by its ID. It specifies the endpoint path, required parameters, and security schemes. ```json { "openapi": "3.1.0", "info": { "title": "nexudus-rest-api", "version": "1.0" }, "servers": [ { "url": "https://spaces.nexudus.com/api" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/apps/installedmarketplaceapplications/{id}": { "get": { "summary": "Get one InstalledMarketPlaceApplication", "description": "This endpoint lets you get a single Installed Market Place Application record by its Id", "operationId": "get-installedmarketplaceapplication", "parameters": [ { "name": "id", "in": "path", "description": "The integer id of the Installed Market Place Application record to get.", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### POST /billing/tariffsignupproducts/runcommand Source: https://developers.nexudus.com/reference/commands-run-tariffsignupproduct Executes a specified command for one or more Sign-up Product records. This is useful for performing bulk actions or updates on product sign-ups. ```APIDOC ## POST /billing/tariffsignupproducts/runcommand ### Description This endpoint allows you to run a command for one or more Sign-up Product records. It is designed for executing specific actions or operations on selected product sign-ups. ### Method POST ### Endpoint /billing/tariffsignupproducts/runcommand ### Parameters #### Request Body - **Key** (string) - Required - The key for the command to execute. - **Ids** (array of integers) - Required - The list of record identifiers (Id field) for the Sign-up Product records to execute this command for. - **Parameters** (array of objects) - Required - If this command requires any parameters, the name and value for each of them. - **Type** (string) - Required - The type of the parameter. - **Value** (string) - Required - The value of the parameter. ### Request Example ```json { "Key": "your_command_key", "Ids": [ 123, 456 ], "Parameters": [ { "Type": "parameter_type", "Value": "parameter_value" } ] } ``` ### Response #### Success Response (200) - **Status** (integer) - The status code of the response. - **Message** (string) - A message indicating the result of the operation. - **Value** (object) - Contains the ID of the operation or related data. - **Id** (integer) - The identifier for the executed command. - **RedirectURL** (any) - A URL to redirect to, if applicable. - **UpdatedOn** (string) - The timestamp when the record was last updated. - **UpdatedBy** (string) - The user who last updated the record. - **Errors** (any) - Any errors that occurred during the operation. - **WasSuccessful** (boolean) - Indicates whether the operation was successful. #### Response Example ```json { "Status": 200, "Message": "The command was run correctly.", "Value": { "Id": 10605 }, "RedirectURL": null, "UpdatedOn": "2021-04-15T12:19:07Z", "UpdatedBy": "john@example.com", "Errors": null, "WasSuccessful": true } ``` ``` -------------------------------- ### POST /sys/floorplanlayoutopenings/runcommand Source: https://developers.nexudus.com/reference/commands-run-floorplanlayoutopening This endpoint allows you to execute a specific command on one or more Floor Plan Layout Opening records. You need to provide the command key, the IDs of the records, and any necessary parameters for the command. ```APIDOC ## POST /sys/floorplanlayoutopenings/runcommand ### Description This endpoint lets you run a command for one or more Floor Plan Layout Opening records. ### Method POST ### Endpoint /sys/floorplanlayoutopenings/runcommand ### Parameters #### Request Body - **Key** (string) - Required - The key for the command to execute. - **Ids** (array of integer) - Required - The list of record identifiers (Id field) for the Floor Plan Layout Opening records to execute this command for. - **Parameters** (array of object) - Required - If this command requires any parameters, the name and value for each of them. - **Type** (string) - Required - The type of the parameter. - **Value** (string) - Required - The value of the parameter. ### Request Example ```json { "Key": "your_command_key", "Ids": [1, 2, 3], "Parameters": [ { "Type": "param_type", "Value": "param_value" } ] } ``` ### Response #### Success Response (200) - **Status** (integer) - The status code of the response. Example: 200. - **Message** (string) - A message indicating the result of the operation. Example: "The command was run correctly.". - **Value** (object) - Contains additional details about the operation, such as the ID of the affected record. Example: `{"Id":10605}`. - **RedirectURL** (any) - A URL to redirect to, if applicable. - **UpdatedOn** (string) - The timestamp when the record was last updated. Example: "2021-04-15T12:19:07Z". - **UpdatedBy** (string) - The email address of the user who last updated the record. Example: "john@example.com". - **Errors** (any) - Contains any errors encountered during the operation. - **WasSuccessful** (boolean) - Indicates whether the operation was successful. Example: true. #### Response Example ```json { "Status": 200, "Message": "The command was run correctly.", "Value": { "Id": 10605 }, "RedirectURL": null, "UpdatedOn": "2021-04-15T12:19:07Z", "UpdatedBy": "john@example.com", "Errors": null, "WasSuccessful": true } ``` ``` -------------------------------- ### Get Installed Market Place Application by ID Source: https://developers.nexudus.com/reference/get-installedmarketplaceapplication Retrieves a single Installed Market Place Application record using its unique identifier. This endpoint requires read permissions for Installed Market Place Applications. ```APIDOC ## GET /apps/installedmarketplaceapplications/{id} ### Description This endpoint lets you get a single Installed Market Place Application record by its Id. ### Method GET ### Endpoint /apps/installedmarketplaceapplications/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The integer id of the Installed Market Place Application record to get. ### Request Example ```json { "example": "No request body needed for GET request." } ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the installed marketplace application. - **name** (string) - The name of the marketplace application. - **version** (string) - The installed version of the application. - **isEnabled** (boolean) - Indicates if the application is currently enabled. #### Response Example ```json { "id": 123, "name": "Example App", "version": "1.0.0", "isEnabled": true } ``` #### Error Response (404) - **message** (string) - "Not Found" or a specific error message if the application with the given ID does not exist. #### Error Response Example ```json { "message": "InstalledMarketPlaceApplication with id 999 not found." } ``` ``` -------------------------------- ### Example Request for Get Booking Price Source: https://developers.nexudus.com/reference/get-price This JSON object represents an example request payload for the 'Get Booking Price' API. It includes details about the booking, such as the resource ID and desired time frame, as well as a list of products with their respective quantities. ```json { "booking": { "Id": 0, "ResourceId": 1004591591, "ToTime": "2022-11-22T13:00:00.000Z", "resource": { "Id": 1004591591 }, "floorPlanDesk": {} }, "products": [ { "Id": 1006722720, "ProductId": 1006721716, "RequestQuantity": false, "Quantity": 1 } ] } ``` -------------------------------- ### POST /websites/developers_nexudus_reference/floorplanlayoutopenings Source: https://developers.nexudus.com/reference/add-floorplanlayoutopening Adds a new Floor Plan Layout Opening record. Requires 'FloorPlanLayoutOpening-Create' role. ```APIDOC ## POST /websites/developers_nexudus_reference/floorplanlayoutopenings ### Description Adds a new Floor Plan Layout Opening record. ### Method POST ### Endpoint /websites/developers_nexudus_reference/floorplanlayoutopenings ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **name** (string) - Required - The name of the opening. - **description** (string) - Optional - A description of the opening. - **type** (string) - Required - The type of opening (e.g., "door", "window"). - **width** (number) - Required - The width of the opening in units. - **height** (number) - Required - The height of the opening in units. - **x** (number) - Required - The x-coordinate of the opening's position. - **y** (number) - Required - The y-coordinate of the opening's position. ### Request Example ```json { "name": "Main Door", "description": "Entrance door to the office", "type": "door", "width": 1.0, "height": 2.1, "x": 5.0, "y": 10.5 } ``` ### Response #### Success Response (201 Created) - **id** (string) - The unique identifier for the created Floor Plan Layout Opening. - **name** (string) - The name of the opening. - **description** (string) - A description of the opening. - **type** (string) - The type of opening. - **width** (number) - The width of the opening. - **height** (number) - The height of the opening. - **x** (number) - The x-coordinate of the opening's position. - **y** (number) - The y-coordinate of the opening's position. #### Response Example ```json { "id": "f1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c", "name": "Main Door", "description": "Entrance door to the office", "type": "door", "width": 1.0, "height": 2.1, "x": 5.0, "y": 10.5 } ``` #### Error Response (400 Bad Request) - **error** (string) - Description of the error. #### Error Response Example ```json { "error": "Invalid input data. Width and height must be positive numbers." } ``` #### Error Response (403 Forbidden) - **error** (string) - Description of the error. #### Error Response Example ```json { "error": "User does not have the required role to perform this action." } ``` ``` -------------------------------- ### Get Support Departments (JSON Example) Source: https://developers.nexudus.com/reference/get-departments This example demonstrates the JSON response structure when retrieving support departments via the API. It includes department names, descriptions, IDs, and timestamps. No external dependencies are required to interpret this structure. ```json { "Departments": [ { "Name": "CANCELLATIONS", "Description": "If you want to cancel your membership and you have questions please write here", "Id": 1012922911, "IdString": "1012922911", "UpdatedOn": "2019-05-03T08:34:49", "CreatedOn": "2019-05-03T08:34:49", "UniqueId": "e4361a18-d9f9-4a49-a2af-7ae3efff3b5d", "IsNull": false }, { "Name": "EVENTS", "Description": "Do you want to organise an event? Contact us here!", "Id": 1012554545, "IdString": "1012554545", "UpdatedOn": "2019-05-03T08:34:15", "CreatedOn": "2019-05-03T08:34:15", "UniqueId": "0e3928e2-1064-4111-a6d2-1063197dfd89", "IsNull": false }, { "Name": "FINANCE", "Description": "Any queries connected to finance, invoicing and billing", "Id": 1012921910, "IdString": "1012921910", "UpdatedOn": "2020-01-22T14:54:20", "CreatedOn": "2019-05-03T08:33:37", "UniqueId": "629a77b1-0f97-44d2-8aa8-5e92936ad735", "IsNull": false }, { "Name": "IT/TECHNICAL", "Description": "Any queries connected to the technical issues/questions ex. Internet does not work", "Id": 1012919908, "IdString": "1012919908", "UpdatedOn": "2019-05-03T08:32:54", "CreatedOn": "2019-05-03T08:32:54", "UniqueId": "75eb982c-c2b5-419c-8ab9-85b16a2a834a", "IsNull": false } ], "Message": null } ``` -------------------------------- ### Get Multiple InstalledMarketPlaceApplications Source: https://developers.nexudus.com/reference/get-multiple-installedmarketplaceapplication This endpoint retrieves multiple Installed Market Place Application records by their IDs. You can provide a list of identifiers in the path, enclosed in square brackets. ```APIDOC ## GET /apps/installedmarketplaceapplications/?id=[{id1},{id2},{id3},{idn}] ### Description Retrieves multiple Installed Market Place Application records by their IDs. You can pass a number of identifiers in the path of the request enclosed by square brackets ([]). ### Method GET ### Endpoint /apps/installedmarketplaceapplications/?id=[{id1},{id2},{id3},{idn}] ### Parameters #### Path Parameters - **id1** (integer) - Required - The integer id of the 1st Installed Market Place Application record to get. - **id2** (integer) - Required - The integer id of the 2nd Installed Market Place Application record to get. - **id3** (integer) - Required - The integer id of the 3rd Installed Market Place Application record to get. - **idn** (integer) - Required - The integer id of the Nth Installed Market Place Application record to get. ### Request Example ```json { "example": "GET /api/apps/installedmarketplaceapplications/?id=[1,2,3]" } ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the Installed Market Place Application. - **name** (string) - The name of the Installed Market Place Application. - **version** (string) - The version of the Installed Market Place Application. #### Response Example ```json { "example": [ { "id": 1, "name": "Example App 1", "version": "1.0.0" }, { "id": 2, "name": "Example App 2", "version": "1.1.0" } ] } ``` ``` -------------------------------- ### GET /en/legal/visitor Source: https://developers.nexudus.com/reference/visitors Retrieves the terms and conditions for a visitor to accept, identified by a unique GUID. ```APIDOC ## GET /en/legal/visitor ### Description Retrieves the terms and conditions to be accepted by a visitor. ### Method GET ### Endpoint `https://{defaultBusinessWebAddress}.spaces.nexudus.com/en/legal/visitor?guid={guid}` ### Parameters #### Path Parameters - **guid** (string) - Required - The UniqueId of the visitor ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **Title** (string) - The title of the terms and conditions. - **Text** (string) - The full text of the terms and conditions. - **AcceptUrl** (string) - The URL where the visitor can accept the terms. #### Response Example ```json { "Title": "Example Terms Title", "Text": "These are the example terms and conditions.", "AcceptUrl": "https://example.com/accept" } ``` ``` -------------------------------- ### GET /billing/tariffsignupproducts Source: https://developers.nexudus.com/reference/search-tariffsignupproduct This endpoint lets you return a list of Sign-up Product records or search for one or more Sign-up Product records based on one or more parameters. ```APIDOC ## GET /billing/tariffsignupproducts ### Description This endpoint lets you return a list of Sign-up Product records or search for one or more Sign-up Product records based on one or more parameters. ### Method GET ### Endpoint /billing/tariffsignupproducts ### Parameters #### Query Parameters - **page** (integer) - Optional - The page of Sign-up Product records to retrieve - **size** (integer) - Optional - The number of Sign-up Product records to include in each page - **orderBy** (string) - Optional - The property by which to sort the results - **dir** (string) - Optional - The direction in which Sign-up Product records will be sorted (enum: Ascending, Descending) - **TariffSignupProduct_Tariff** (integer) - Optional - Filters Sign-up Product records by Tariff. - **TariffSignupProduct_Product** (integer) - Optional - Filters Sign-up Product records by Product. - **TariffSignupProduct_ProductPrice** (number) - Optional - Filters Sign-up Product records by ProductPrice. - **TariffSignupProduct_Price** (number) - Optional - Filters Sign-up Product records by Price. - **TariffSignupProduct_Refundable** (boolean) - Optional - Filters Sign-up Product records by Refundable. - **UniqueId** (string) - Optional - Filters Sign-up Product records by UniqueId. - **TariffSignupProduct_SystemId** (string) - Optional - Filters Sign-up Product records by SystemId. - **from_TariffSignupProduct_UpdatedOn** (string) - Optional - Sets the minimun date/time value for UpdatedOn. (Use YYYY-MM-DDTHH:mm format) - **to_TariffSignupProduct_UpdatedOn** (string) - Optional - Sets the maximum date/time value for UpdatedOn. (Use YYYY-MM-DDTHH:mm format) - **from_TariffSignupProduct_CreatedOn** (string) - Optional - Sets the minimun date/time value for CreatedOn. (Use YYYY-MM-DDTHH:mm format) - **to_TariffSignupProduct_CreatedOn** (string) - Optional - Sets the maximum date/time value for CreatedOn. (Use YYYY-MM-DDTHH:mm format) ### Response #### Success Response (200) * (Type of response data not specified in the input) #### Response Example (Response example not provided in the input) ``` -------------------------------- ### API Documentation Examples Source: https://developers.nexudus.com/reference/add-surveyrun This section provides examples of API structures and potential responses, illustrating how data is formatted. ```APIDOC ## API Response Structure Example ### Description This example illustrates a potential API response structure, including success status and detailed error information if applicable. ### Method N/A (Illustrative Example) ### Endpoint N/A (Illustrative Example) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Result** (object) - Contains the main payload of the API response. - **WasSuccessful** (boolean) - Indicates if the operation was successful. - **Message** (string) - A message describing the outcome of the operation. - **Errors** (object) - Contains details about any errors encountered. - **Code** (string) - The error code. - **Message** (string) - A message detailing the error. - **PropertyName** (string) - The name of the property related to the error. #### Response Example ```json { "Result": { "WasSuccessful": false, "Message": "may not be null or empty", "Errors": { "Code": "ValidationError", "Message": "may not be null or empty", "PropertyName": "Name" } } } ``` ``` -------------------------------- ### Get Visitor Terms API Request (PHP) Source: https://developers.nexudus.com/reference/visitors Example PHP code to fetch visitor terms and conditions using cURL. It sends a GET request to the Nexudus API. ```php ``` -------------------------------- ### POST /installedmarketplaceapplications Source: https://developers.nexudus.com/reference/add-installedmarketplaceapplication Adds a new Installed Market Place Application record. This operation requires the 'InstalledMarketPlaceApplication-Create' role. ```APIDOC ## POST /installedmarketplaceapplications ### Description Adds a new Installed Market Place Application record. ### Method POST ### Endpoint /installedmarketplaceapplications ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **name** (string) - Required - The name of the marketplace application. - **version** (string) - Required - The version of the marketplace application. - **configuration** (object) - Optional - Configuration details for the application. ### Request Example ```json { "name": "ExampleApp", "version": "1.0.0", "configuration": { "setting1": "value1" } } ``` ### Response #### Success Response (201 Created) - **id** (string) - The unique identifier of the newly created Installed Market Place Application. - **name** (string) - The name of the marketplace application. - **version** (string) - The version of the marketplace application. - **configuration** (object) - Configuration details for the application. #### Response Example ```json { "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "name": "ExampleApp", "version": "1.0.0", "configuration": { "setting1": "value1" } } ``` ``` -------------------------------- ### Get Location Information (Ruby) Source: https://developers.nexudus.com/reference/location A Ruby example for fetching location details via the Nexudus API. It utilizes the 'net/http' library to perform the GET request and parse the JSON response. ```ruby require 'net/http' require 'uri' require 'json' def get_business_info uri = URI.parse('https://your_domain.spaces.nexudus.com/en/business') http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Get.new(uri.request_uri) request['Content-Type'] = 'application/json' request['accept'] = 'application/json' begin response = http.request(request) puts JSON.parse(response.body) return JSON.parse(response.body) rescue Net::HTTPServerException => e puts "Error fetching business info: #{e.message}" rescue JSON::ParserError => e puts "Error parsing JSON: #{e.message}" end end get_business_info() ``` -------------------------------- ### Resource Data Structure Example (JSON) Source: https://developers.nexudus.com/reference/delete-bookings-1 This JSON object describes a resource, such as a meeting room. It includes its name, associated business, visibility settings, and group. The 'Description' field may contain HTML content. ```json { "Resource":{ "Name":"DVI Room", "BusinessId":1004930927, "BusinessName":"Kalkio Space - East Side", "Visible":true, "GroupName":"Boardrooms", "Description":"

``` -------------------------------- ### Get Invoices API Request (Node.js) Source: https://developers.nexudus.com/reference/invoices This Node.js example shows how to make a GET request to the Nexudus API to fetch invoices. It uses the 'node-fetch' library to handle the HTTP request. ```javascript import fetch from 'node-fetch'; const options = { method: 'GET', headers: { 'Content-Type': 'application/json', 'accept': 'application/json' } }; fetch('https://your_domain.spaces.nexudus.com/en/invoices', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err)); ``` -------------------------------- ### Signup Configuration API Source: https://developers.nexudus.com/reference/account-configuration This section details the configuration options available for user signups, including enabling features like Google Plus signup, holding new accounts, requiring price plan selection, showing the store on signup, and using CAPTCHA. ```APIDOC ## GET /api/signup/configuration ### Description Retrieves the current signup configuration settings for the workspace. ### Method GET ### Endpoint /api/signup/configuration ### Parameters None ### Request Example None ### Response #### Success Response (200) - **Signup.GooglePlusSignUp** (string) - Indicates if Google Plus signup is enabled. - **Signup.KeepNewAccountsOnHold** (string) - Indicates if new accounts are kept on hold. - **Signup.MemberMustChooseAPricePlan** (string) - Indicates if members must choose a price plan. - **Signup.ShowStoreOnSignUp** (string) - Indicates if the store is shown during signup. - **Signup.UseCaptcha** (string) - Indicates if CAPTCHA is used during signup. #### Response Example ```json { "Signup.GooglePlusSignUp": null, "Signup.KeepNewAccountsOnHold": "true", "Signup.MemberMustChooseAPricePlan": "true", "Signup.ShowStoreOnSignUp": "true", "Signup.UseCaptcha": "true" } ``` ``` -------------------------------- ### Get User Notifications API Request (PHP) Source: https://developers.nexudus.com/reference/notifications This PHP example shows how to get user notifications from the Nexudus API using cURL. It sets the GET request method and includes the necessary headers for a successful API call. ```php ```