{ "openapi": "3.0.4", "info": { "title": "FIOAPI", "description": "API for FIO Database", "version": "v1" }, "paths": { "/admin": { "get": { "tags": [ "Admin" ], "summary": "Checks to see if the current user is an administrator", "responses": { "200": { "description": "You are admin" }, "401": { "description": "Not logged in" }, "403": { "description": "You are not admin" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/isuser/{UserName}": { "get": { "tags": [ "Admin" ], "summary": "Checks to see if the provided username is a user", "parameters": [ { "name": "UserName", "in": "path", "description": "UserName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Is a valid user" }, "204": { "description": "Not a valid user" }, "400": { "description": "Invalid UserName", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/createaccount": { "post": { "tags": [ "Admin" ], "summary": "Creates an account", "requestBody": { "description": "The account creation payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccount" } } } }, "responses": { "200": { "description": "Successfully created account" }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin or using read-only api key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/deleteaccount/{UserName}": { "delete": { "tags": [ "Admin" ], "summary": "Deletes the account of the given username", "parameters": [ { "name": "UserName", "in": "path", "description": "The username to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully created account" }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin or using read-only api key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/clearcxdata": { "delete": { "tags": [ "Admin" ], "summary": "Clears all CX data", "responses": { "200": { "description": "Deleted all CX Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/clearchatdata": { "delete": { "tags": [ "Admin" ], "summary": "Clears all chat data", "responses": { "200": { "description": "Deleted all CX Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/clearbuidata": { "delete": { "tags": [ "Admin" ], "summary": "Clears all BUI data", "responses": { "200": { "description": "Deleted all BUI Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } } } }, "/admin/clearmatdata": { "delete": { "tags": [ "Admin" ], "summary": "Clears all MAT data", "responses": { "200": { "description": "Deleted all MAT Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } } } }, "/admin/clearjumpcache": { "delete": { "tags": [ "Admin" ], "summary": "Clears all JumpCache data", "responses": { "200": { "description": "Deleted all JumpCache Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } } } }, "/admin/clearstationdata": { "delete": { "tags": [ "Admin" ], "summary": "Clears all station data", "responses": { "200": { "description": "Deleted all station Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } } } }, "/admin/clearmapdata": { "delete": { "tags": [ "Admin" ], "summary": "Clears all map data", "responses": { "200": { "description": "Deleted all map Data" }, "401": { "description": "Not logged in" }, "403": { "description": "Not an admin" } } } }, "/admin/requestlogging/start/{UserName}": { "put": { "tags": [ "Admin" ], "summary": "Starts a logging session", "parameters": [ { "name": "UserName", "in": "path", "description": "The username to start a logging session for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Logging started" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/requestlogging/cancel/{UserName}": { "put": { "tags": [ "Admin" ], "summary": "Cancels a logging session", "parameters": [ { "name": "UserName", "in": "path", "description": "The username to cancel a logging session for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Logging cancelled" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/admin/requestlogging/finish/{UserName}": { "put": { "tags": [ "Admin" ], "summary": "Finish a logging session and return the payload", "parameters": [ { "name": "UserName", "in": "path", "description": "The username to finish a logging session for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Finish logging and receive the payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinishedRequestPayload" } } } }, "204": { "description": "No active session for user found" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/apexuser": { "put": { "tags": [ "APEXUser" ], "summary": "PUTs PATH_USERS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_USERS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_USERS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_USERS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "APEXUser" ], "summary": "Retrieves user(s) that match the provided user string. (If not present, retrieves all users)", "parameters": [ { "name": "user", "in": "query", "description": "UserId, UserName, or CompanyCode", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Payload accepted" } } } }, "/apexuser/presence": { "put": { "tags": [ "APEXUser" ], "summary": "PUTs ROOT_PRESENCE_LIST payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRESENCE_LIST" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRESENCE_LIST" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_PRESENCE_LIST" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth": { "get": { "tags": [ "Auth" ], "summary": "Checks to see if you are logged in", "responses": { "200": { "description": "You are logged in", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "You are not logged in", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Logs the user in providing a Jwt bearer token", "description": "\nThe Token result should be used in future requests by adding a header which is:\n\n\n\n\n```Authorization: Bearer {Token}```", "requestBody": { "description": "The login payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Login" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Login" } } } }, "responses": { "200": { "description": "Successfully logged in", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid username and/or password" } } } }, "/auth/createapikey": { "post": { "tags": [ "Auth" ], "summary": "Creates an API Key", "description": "The APIKey result should be used in future requests by adding a header which is:\n\n```Authorization: FIOAPIKey {APIKey}```", "requestBody": { "description": "The CreateAPIKey payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAPIKey" } } } }, "responses": { "200": { "description": "Successfully created APIKey", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid user/pass combination" }, "403": { "description": "Improperly using a read-only APIKey" }, "406": { "description": "Reached maximum threshold of APIKeys", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/revokeapikey": { "post": { "tags": [ "Auth" ], "summary": "Revokes an API Key", "description": "Revoking an API Key requires using a JWT or writable APIKey (actively logged in)", "requestBody": { "description": "The RevokeAPIKey payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeAPIKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeAPIKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeAPIKey" } } } }, "responses": { "200": { "description": "Successfully revoked API Key" }, "204": { "description": "APIKey not found" }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid user/pass combination" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/listapikeys": { "get": { "tags": [ "Auth" ], "summary": "Retrieves all APIKeys for the logged in user", "description": "Note that this requires either a JWT or a writable API key", "responses": { "200": { "description": "Retrieved API Keys", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIKey" } } } } }, "401": { "description": "Not logged in or using a read-only APIKey" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/changepassword": { "post": { "tags": [ "Auth" ], "summary": "Changes an account password", "description": "Changing your password requires using a JWT or writable APIKey (actively logged in)", "requestBody": { "description": "The ChangePassword payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePassword" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePassword" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePassword" } } } }, "responses": { "200": { "description": "Successfully changed password", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid password or not logged in", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/autorequestregister": { "post": { "tags": [ "Auth" ], "summary": "Runs AutoRegistration (leveraged by extension)", "description": "This is only used by the extension", "requestBody": { "description": "AutoRequestRegister payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoRequestRegister" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutoRequestRegister" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AutoRequestRegister" } } } }, "responses": { "200": { "description": "Successfully received AutoRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoRequestRegisterResponse" } } } }, "204": { "description": "Already a user" }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/auth/register": { "post": { "tags": [ "Auth" ], "summary": "Creates an account given a registration (leveraged by extension/FIOWeb)", "description": "This is only used by the extension and FIOWeb", "requestBody": { "description": "Register payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Register" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Register" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Register" } } } }, "responses": { "200": { "description": "Successfully registered and created account" }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "No registration found" } } } }, "/auth/resetgamedata": { "delete": { "tags": [ "Auth" ], "summary": "Clears/resets game data", "parameters": [ { "name": "company", "in": "query", "description": "if company data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "contracts", "in": "query", "description": "if contracts data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "cxos", "in": "query", "description": "if cxos data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "experts", "in": "query", "description": "if experts data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "flights", "in": "query", "description": "if flights data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "production_lines", "in": "query", "description": "if production_lines data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "ships", "in": "query", "description": "if ships data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "sites", "in": "query", "description": "if sites data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "storages", "in": "query", "description": "if storages data should be deleted", "schema": { "type": "boolean", "default": true } }, { "name": "workforces", "in": "query", "description": "if workforces data should be deleted", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successfully cleared game data" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/deleteaccount": { "post": { "tags": [ "Auth" ], "summary": "Deletes your account (requires you be auth'd when deleting)", "requestBody": { "description": "DeleteAccount payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAccount" } } } }, "responses": { "200": { "description": "Successfully deleted account" }, "400": { "description": "Failed payload validation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Password incorrect" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/discord": { "get": { "tags": [ "Auth" ], "summary": "Gets the discord name for the user", "responses": { "200": { "description": "Successfully retrieved discord name", "content": { "plain/text": { "schema": { "type": "string" } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "put": { "tags": [ "Auth" ], "summary": "Sets the user's discord name (id)", "requestBody": { "description": "The SetDiscord payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDiscord" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetDiscord" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetDiscord" } } } }, "responses": { "200": { "description": "Successfully set discord name" }, "400": { "description": "Failed payload validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/users": { "get": { "tags": [ "Auth" ], "summary": "Retrieves a list of all FIO user naems", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/auth/webhook": { "post": { "tags": [ "Auth" ], "summary": "Sets the webhook for the account", "requestBody": { "description": "The SetWebhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWebhook" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetWebhook" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetWebhook" } } } }, "responses": { "200": { "description": "Successfully set webhook url" }, "400": { "description": "Failed payload validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Auth" ], "summary": "Retrieves the webhook for the account", "responses": { "200": { "description": "Successfully retrieved webhook url", "content": { "text/plain": { "schema": { "type": "string" } } } }, "204": { "description": "No webhook registered" }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "delete": { "tags": [ "Auth" ], "summary": "Deletes the webhook for the account", "responses": { "200": { "description": "Successfully deleted webhook url" }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/auth/anonymousdatacollection": { "get": { "tags": [ "Auth" ], "summary": "Retrieves whether anonymous data collection is enabled.\nEnabling this means users can get your anonymized data for research purposes\nsuch as determining flight formulas.", "responses": { "200": { "description": "Successfully retrieved", "content": { "text/plain": { "schema": { "type": "boolean" } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "post": { "tags": [ "Auth" ], "summary": "Sets whether anonymous data collection is enabled.\nEnabling this means users can get your anonymized data for research purposes\nsuch as determining flight formulas.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAllowAnonymousDataCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetAllowAnonymousDataCollection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetAllowAnonymousDataCollection" } } } }, "responses": { "200": { "description": "Successfully set anonymous data collection" }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only APIKey" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/building": { "put": { "tags": [ "Building" ], "summary": "PUTs the building payload (MESG WORLD_REACTOR_DATA) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Building" ], "summary": "Retrieves all buildings", "parameters": [ { "name": "include_costs", "in": "query", "description": "If building costs should be included [default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "include_planet_costs", "in": "query", "description": "If building planet costs should be included (requires include_costs be true) [default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "pressure", "in": "query", "description": "The pressure of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "temperature", "in": "query", "description": "The temperature of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "gravity", "in": "query", "description": "The gravity of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "rocky", "in": "query", "description": "If the planet is rocky [default: true]", "schema": { "type": "boolean", "default": true } }, { "name": "include_recipes", "in": "query", "description": "if recipes should be included [default: false]", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Building" } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/building/{BuildingTicker}": { "get": { "tags": [ "Building" ], "summary": "Retrieves the specified building by ticker", "parameters": [ { "name": "BuildingTicker", "in": "path", "description": "The Building ticker", "required": true, "schema": { "type": "string" } }, { "name": "include_costs", "in": "query", "description": "If building costs should be included [default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "include_planet_costs", "in": "query", "description": "If building planet costs should be included (requires include_costs be true) [default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "pressure", "in": "query", "description": "The pressure of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "temperature", "in": "query", "description": "The temperature of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "gravity", "in": "query", "description": "The gravity of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "rocky", "in": "query", "description": "If the planet is rocky. [default: true]", "schema": { "type": "boolean", "default": true } }, { "name": "include_recipes", "in": "query", "description": "if recipes should be included [default: false]", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Building" } } } }, "204": { "description": "Not found" }, "400": { "description": "Ticker specified outside the valid range" } } } }, "/building/corebasebuildings": { "get": { "tags": [ "Building" ], "summary": "Retrieves all core base buildings", "parameters": [ { "name": "include_costs", "in": "query", "description": "If building costs should be included [default: true]", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Building" } } } } } } } }, "/building/habitationbuildings": { "get": { "tags": [ "Building" ], "summary": "Retrieves all habitation buildings", "parameters": [ { "name": "include_costs", "in": "query", "description": "If building costs should be included [default: true]", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Building" } } } } } } } }, "/building/planetaryprojectbuildings": { "get": { "tags": [ "Building" ], "summary": "Retrieves all planetary project buildings", "parameters": [ { "name": "include_costs", "in": "query", "description": "If building costs should be included [default: true]", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Building" } } } } } } } }, "/building/corporationprojectbuildings": { "get": { "tags": [ "Building" ], "summary": "Retrieves all corporation project building", "parameters": [ { "name": "include_costs", "in": "query", "description": "If building costs should be included [default: true]", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Building" } } } } } } } }, "/chat/channel": { "put": { "tags": [ "Chat" ], "summary": "PUTs a MESG_CHANNEL_DATA payload", "requestBody": { "description": "The MESG_CHANNEL_DATA payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_CHANNEL_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_CHANNEL_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_CHANNEL_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/channel/root": { "put": { "tags": [ "Chat" ], "summary": "PUTs a ROOT_CHANNEL_DATA payload", "requestBody": { "description": "The ROOT_CHANNEL_DATA payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_CHANNEL_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_CHANNEL_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_CHANNEL_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/messageaddedself": { "put": { "tags": [ "Chat" ], "summary": "PUTs a CHANNEL_MESSAGE_ADDED_SELF payload", "requestBody": { "description": "The CHANNEL_MESSAGE_ADDED_SELF payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_CHANNEL_MESSAGE_ADDED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_CHANNEL_MESSAGE_ADDED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_CHANNEL_MESSAGE_ADDED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/messageadded": { "put": { "tags": [ "Chat" ], "summary": "PUTs a CHANNEL_MESSAGE_ADDED payload", "requestBody": { "description": "The CHANNEL_MESSAGE_ADDED payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_CHANNEL_MESSAGE_ADDED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_CHANNEL_MESSAGE_ADDED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_CHANNEL_MESSAGE_ADDED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/messagedeleted": { "put": { "tags": [ "Chat" ], "summary": "PUTs a CHANNEL_MESSAGE_DELETED payload", "requestBody": { "description": "The CHANNEL_MESSAGE_DELETED payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_DELETED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_DELETED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_DELETED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/messagelist": { "put": { "tags": [ "Chat" ], "summary": "PUTs a CHANNEL_MESSAGE_LIST payload", "requestBody": { "description": "The CHANNEL_MESSAGE_LIST payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/userjoined": { "put": { "tags": [ "Chat" ], "summary": "PUTs a CHANNEL_USER_JOINED payload", "requestBody": { "description": "The CHANNEL_USER_JOINED payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_USER_JOINED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_USER_JOINED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CHANNEL_USER_JOINED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/userleft": { "put": { "tags": [ "Chat" ], "summary": "PUTs a CHANNEL_USER_LEFT payload", "requestBody": { "description": "The CHANNEL_USER_LEFT payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_USER_LEFT" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CHANNEL_USER_LEFT" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CHANNEL_USER_LEFT" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/chat/list": { "get": { "tags": [ "Chat" ], "summary": "Retries a list of channels", "parameters": [ { "name": "types", "in": "query", "description": "[Optional] The list of channel types to return", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatChannel" } } } } }, "400": { "description": "Request failed validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/chat/messages": { "get": { "tags": [ "Chat" ], "summary": "Retrieves a list of messages given the queried parameters.", "description": "The maximum number of messages retrievable is 1000", "parameters": [ { "name": "channel_names", "in": "query", "description": "[Optional] List of channel names, `&` separated", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "channel_ids", "in": "query", "description": "[Optional] List of channel ids, `&` separated", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "updated_since", "in": "query", "description": "[Optional] Only retrieve messages which were updated since this time", "schema": { "type": "string", "format": "date-time" } }, { "name": "skip", "in": "query", "description": "[Optional] Offset or skip this number of messages from the start of the result. Default 0", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "top", "in": "query", "description": "[Optional] Take this number of messages. Default 1000", "schema": { "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } } } } }, "400": { "description": "Request failed validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/chat/user/{username}/{channel_id}": { "get": { "tags": [ "Chat" ], "summary": "Gets chat messages of the provided user in the provided channel_id", "description": "This will return a maximum of 1000 chat messages", "parameters": [ { "name": "username", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "channel_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "[Optional] Offset or skip this number of messages from the start of the result", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "top", "in": "query", "description": "[Optional] Take this number of messages", "schema": { "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } } } } }, "400": { "description": "Request failed validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/company": { "put": { "tags": [ "Company" ], "summary": "PUTs a PATH_COMPANY payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_COMPANY" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_COMPANY" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_COMPANY" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Company" ], "summary": "Retrieves one or more company data by ONE of the following:\n- Company name/code/id\n- APEX username\n- Group", "parameters": [ { "name": "company", "in": "query", "description": "Provided company name(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "The group (can only be used if authenticated)", "schema": { "type": "string" } }, { "name": "include_planets", "in": "query", "description": "Whether planets should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_offices", "in": "query", "description": "Whether offices should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/company/selfroot": { "put": { "tags": [ "Company" ], "summary": "PUTs a ROOT_COMPANY_DATA payload", "requestBody": { "description": "Payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_COMPANY_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_COMPANY_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_COMPANY_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/company/selfmsg": { "put": { "tags": [ "Company" ], "summary": "PUTs a MESG_COMPANY_DATA payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_COMPANY_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_COMPANY_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_COMPANY_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/company/offices": { "put": { "tags": [ "Company" ], "summary": "PUTs a PATH_COMPANIES_OFFICES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/company/accounting": { "put": { "tags": [ "Company" ], "summary": "PUTs account cash balances", "requestBody": { "description": "The balances payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/company/lookup": { "get": { "tags": [ "Company" ], "summary": "Retrieves a list of companies specified via url parameters.", "parameters": [ { "name": "company", "in": "query", "description": "The company code/id/name", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_planets", "in": "query", "description": "If planets should be included in the result", "schema": { "type": "boolean", "default": false } }, { "name": "include_offices", "in": "query", "description": "If offices should be included in the result", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } }, "400": { "description": "Did not specify any companies or too many (max 10)" } } } }, "/contracts": { "put": { "tags": [ "Contracts" ], "summary": "PUTs a MESG_CONTRACTS_CONTRACTS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Contracts" ], "summary": "Retrieves contracts for the given username(s)", "parameters": [ { "name": "username", "in": "query", "description": "User to retrieve data for", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "[Optional] Filter by the status of the contract. Valid options: \n\n ACTIVE (which is all active types), COMPLETED (which is all completed types),\n ACTIVE types: CLOSED, PARTIALLY_FULFILLED, OPEN, DEADLINE_EXCEEDED\n COMPLETED types: FULFILLED, TERMINATED, CANCELLED, BREACHED, REJECTED", "schema": { "type": "string" } }, { "name": "only_loans", "in": "query", "description": "Only retrieve loans [Default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "count", "in": "query", "description": "The number of contracts up to a max of 1000 [Default: 100]", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "page", "in": "query", "description": "The page of the request (for iterating) [Default: 0]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "ascending", "in": "query", "description": "To order the response by timestamp ascending [Default: false]", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/contracts/contract": { "put": { "tags": [ "Contracts" ], "summary": "PUTs a MESG_CONTRACTS_CONTRACT payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/contracts/contract/change": { "put": { "tags": [ "Contracts" ], "summary": "PUTs a MESG_CONTRACTS_CONTRACT_MESSAGE payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT_MESSAGE" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT_MESSAGE" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT_MESSAGE" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/csv/buildings": { "get": { "tags": [ "CSV" ], "summary": "Retrieves buildings", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/buildingcosts": { "get": { "tags": [ "CSV" ], "summary": "Retrieves building costs", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } }, { "name": "include_planet_costs", "in": "query", "description": "If building planet costs should be included (requires include_costs be true) [default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "pressure", "in": "query", "description": "The pressure of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "temperature", "in": "query", "description": "The temperature of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "gravity", "in": "query", "description": "The gravity of the planet. low, normal, high [default: normal]", "schema": { "type": "string", "default": "normal" } }, { "name": "rocky", "in": "query", "description": "If the planet is rocky [default: true]", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/buildingworkforces": { "get": { "tags": [ "CSV" ], "summary": "Retrieves building workforces", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/buildingrecipes": { "get": { "tags": [ "CSV" ], "summary": "Retrieves building recipes", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/materials": { "get": { "tags": [ "CSV" ], "summary": "Gets all materials", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/resources": { "get": { "tags": [ "CSV" ], "summary": "Gets all resource materials (extractable from a planet)", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/prices": { "get": { "tags": [ "CSV" ], "summary": "Gets all prices", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/prices/condensed": { "get": { "tags": [ "CSV" ], "summary": "Gets all prices in a more condensed format", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/orders": { "get": { "tags": [ "CSV" ], "summary": "Retrieves all orders", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/bids": { "get": { "tags": [ "CSV" ], "summary": "Retrieves all bids", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/recipeinputs": { "get": { "tags": [ "CSV" ], "summary": "Retrieves all recipe inputs", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/recipeoutputs": { "get": { "tags": [ "CSV" ], "summary": "Retrieves all recipe outputs", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/planets": { "get": { "tags": [ "CSV" ], "summary": "Retrieves all planets", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/planetresources": { "get": { "tags": [ "CSV" ], "summary": "Retrieves all planet resources", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/planetproductionfees": { "get": { "tags": [ "CSV" ], "summary": "Get all planet production fees", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/planetdetail": { "get": { "tags": [ "CSV" ], "summary": "Retrieves planet detail information", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/systems": { "get": { "tags": [ "CSV" ], "summary": "Retrieves system information", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/systemlinks": { "get": { "tags": [ "CSV" ], "summary": "Retrieves system links", "parameters": [ { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/planetreports": { "get": { "tags": [ "CSV" ], "summary": "Retrieves planet reports", "parameters": [ { "name": "planet", "in": "query", "description": "Planet(s) to retrieve", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "Number of reports to retrieve. Defaults to 5. Specify -1 for all.", "schema": { "type": "integer", "format": "int32", "default": 5 } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" } } } }, "/csv/localmarket": { "get": { "tags": [ "CSV" ], "summary": "Retrieves LM Ads", "parameters": [ { "name": "planet", "in": "query", "description": "Planet(s) to search", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_buys", "in": "query", "description": "If buys should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_sells", "in": "query", "description": "If sells should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_shipments", "in": "query", "description": "If shipments should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request - Did not specify planets or any include" } } } }, "/csv/workforces": { "get": { "tags": [ "CSV" ], "summary": "Retrieves workforce data", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/workforceneeds": { "get": { "tags": [ "CSV" ], "summary": "Retrieves workforce needs", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/inventory": { "get": { "tags": [ "CSV" ], "summary": "Retrieves inventory", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_bases", "in": "query", "description": "If bases should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_warehouses", "in": "query", "description": "If warehouses should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_ship_stores", "in": "query", "description": "If ship stores should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_ship_stl_stores", "in": "query", "description": "If ship stl fuel stores should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_ship_ftl_stores", "in": "query", "description": "If ship ftl fuel stores should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/reclaimables": { "get": { "tags": [ "CSV" ], "summary": "Retrieves reclaimables", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/repairs": { "get": { "tags": [ "CSV" ], "summary": "Retrieves repairs", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/cxos": { "get": { "tags": [ "CSV" ], "summary": "Retrieves cxos", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/cxos/historical": { "get": { "tags": [ "CSV" ], "summary": "Retrieves historical cxos trade information", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Username to retrieve data for", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the header should be present", "schema": { "type": "boolean", "default": true } }, { "name": "count", "in": "query", "description": "How many entries to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "page", "in": "query", "description": "What page of the entries to retrieve", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "ascending", "in": "query", "description": "If the data should be sorted ascending by time", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/balances": { "get": { "tags": [ "CSV" ], "summary": "Retrieves balances", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/burn": { "get": { "tags": [ "CSV" ], "summary": "Retrieves burn", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/sites": { "get": { "tags": [ "CSV" ], "summary": "Retrieves sites", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/ships": { "get": { "tags": [ "CSV" ], "summary": "Retrieve ships", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request", "content": { "plain/text": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/csv/contracts": { "get": { "tags": [ "CSV" ], "summary": "Retrieves contracts", "parameters": [ { "name": "apikey", "in": "query", "description": "APIKey to use", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "UserName(s)", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "[Optional] Filter by the status of the contract. Valid options: \n\n ACTIVE (which is all active types), COMPLETED (which is all completed types),\n ACTIVE types: CLOSED, PARTIALLY_FULFILLED, OPEN, DEADLINE_EXCEEDED\n COMPLETED types: FULFILLED, TERMINATED, CANCELLED, BREACHED, REJECTED", "schema": { "type": "string" } }, { "name": "only_loans", "in": "query", "description": "Only retrieve loans [Default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "count", "in": "query", "description": "The number of contracts up to a max of 1000 [Default: 100]", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "page", "in": "query", "description": "The page of the request (for iterating) [Default: 0]", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "ascending", "in": "query", "description": "To order the response by timestamp ascending [Default: false]", "schema": { "type": "boolean", "default": false } }, { "name": "include_header", "in": "query", "description": "If the csv header should be present", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid or unspecified APIKey" } } } }, "/cx": { "put": { "tags": [ "CX" ], "summary": "PUTs CX_PRICES payload to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CX_PRICES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CX_PRICES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CX_PRICES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/cx/prices": { "get": { "tags": [ "CX" ], "summary": "Retrieves all prices", "parameters": [ { "name": "include_buy_orders", "in": "query", "description": "If buys should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_sell_orders", "in": "query", "description": "If sells should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CXEntry" } } } } } } } }, "/cx/prices/{ExchangeTicker}": { "get": { "tags": [ "CX" ], "summary": "Retrieves prices for a single exchange ticker", "parameters": [ { "name": "ExchangeTicker", "in": "path", "description": "An exchange ticker in the form XXX.YYY", "required": true, "schema": { "type": "string" } }, { "name": "include_buy_orders", "in": "query", "description": "If buy orders should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_sell_orders", "in": "query", "description": "If sell orders should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CXEntry" } } } }, "204": { "description": "ExchangeTicker not found" }, "400": { "description": "Invalid ExchangeTicker provided", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/cx/cxpc": { "put": { "tags": [ "CX" ], "summary": "PUTs MESG_COMEX_BROKER_PRICES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "CX" ], "summary": "Retrieves CXPC data", "parameters": [ { "name": "ticker", "in": "query", "description": "[Optional] Ticker parameters in the form XXX.YYY", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from_time", "in": "query", "description": "[Optional] The lower end time of data to retrieve in epoch milliseconds", "schema": { "type": "integer", "format": "int64" } }, { "name": "to_time", "in": "query", "description": "[Optional] The upper end time of data to retrieve in epoch milliseconds", "schema": { "type": "integer", "format": "int64" } }, { "name": "interval", "in": "query", "description": "[Optional] Intervals to include in the response", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CXPC" } } } } }, "400": { "description": "Invalid ticker", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/cx/cxos": { "put": { "tags": [ "CX" ], "summary": "PUTs a MESG_COMEX_TRADER_ORDER payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "CX" ], "summary": "Retrieves CXOS data for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "The group", "schema": { "type": "string" } }, { "name": "include_trades", "in": "query", "description": "If trade should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CXOSListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/cx/cxos/historical": { "get": { "tags": [ "CX" ], "summary": "Retrieve historical cxos data for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "How many results", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "page", "in": "query", "description": "The page of the result, starting with page 0", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "ascending", "in": "query", "description": "Asecnding by timestamp", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CXOSTradeHistoricalListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/data": { "get": { "tags": [ "Data" ], "summary": "Retrieves all data for the provided usernames(s)/group", "parameters": [ { "name": "username", "in": "query", "description": "username(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "group", "schema": { "type": "string" } }, { "name": "include_company_data", "in": "query", "description": "If company data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_contract_data", "in": "query", "description": "If contract data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_cxos_data", "in": "query", "description": "If cxos data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_productionline_data", "in": "query", "description": "If productionline data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_ship_data", "in": "query", "description": "If ship data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_flight_data", "in": "query", "description": "If flight data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_site_data", "in": "query", "description": "If site data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_storage_data", "in": "query", "description": "If storage data should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "include_workforce_data", "in": "query", "description": "If workforce data should be retrieved", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllDataRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/data/burn": { "get": { "tags": [ "Data" ], "summary": "Retrieves burn data for the provided username(s)/group", "parameters": [ { "name": "username", "in": "query", "description": "username(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "group", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BurnListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/fx": { "put": { "tags": [ "FX" ], "summary": "Puts the FX BrokerData payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "FX" ], "summary": "Retrieves FX data", "parameters": [ { "name": "include_buys", "in": "query", "description": "If buying orders should be included in the payload", "schema": { "type": "boolean", "default": true } }, { "name": "include_sells", "in": "query", "description": "If selling orders should be included in the payload", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FX" } } } } } } } }, "/gateway": { "put": { "tags": [ "Gateway" ], "summary": "PUTs a DATA_DATA_GATEWAYS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DATA_DATA_GATEWAYS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DATA_DATA_GATEWAYS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DATA_DATA_GATEWAYS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Gateway" ], "summary": "Retrieves gateway information", "parameters": [ { "name": "gateway_name", "in": "query", "description": "[Optional] Gateway id, name, or natural id", "schema": { "type": "string" } }, { "name": "include_upkeeps", "in": "query", "description": "If upkeeps should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_phases", "in": "query", "description": "If phases should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_contractors", "in": "query", "description": "If contractors should be returned", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Gateway" } } } } } } } }, "/gateway/gateway": { "put": { "tags": [ "Gateway" ], "summary": "PUTs a PATH_GATEWAY payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_GATEWAY" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_GATEWAY" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_GATEWAY" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/global/countries": { "put": { "tags": [ "Global" ], "summary": "PUTs the countries payload (MESG_COUNTRY_REGISTRY_COUNTRIES) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key or not an administrator" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Global" ], "summary": "Retrieves all countries", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } } }, "/global/simulationdata": { "put": { "tags": [ "Global" ], "summary": "PUTs the simulation data payload (MESG_SIMULATION_DATA) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_SIMULATION_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_SIMULATION_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_SIMULATION_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key or not an administrator" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Global" ], "summary": "Retrieves Simulation Data", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationData" } } } }, "204": { "description": "No simulation data present" } } } }, "/global/comexexchanges": { "put": { "tags": [ "Global" ], "summary": "PUTs the comex exchange data payload (PATH_COMMODITY_EXCHANGES) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key or not an administrator" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Global" ], "summary": "Retrieves comex exchanges", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComexExchange" } } } } } } } }, "/global/station": { "put": { "tags": [ "Global" ], "summary": "Puts a single station", "requestBody": { "description": "The PATH_STATION payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_STATION" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_STATION" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_STATION" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key or not an administrator" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/global/stations": { "get": { "tags": [ "Global" ], "summary": "Retrieves all stations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Station" } } } } } } } }, "/global/workforceneeds": { "get": { "tags": [ "Global" ], "summary": "Retrieves all workforce needs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkforceRequirement" } } } } } } } }, "/global/extension": { "get": { "tags": [ "Global" ], "summary": "Retrieves endpoint information for use by the extension", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/global/registration_url": { "get": { "tags": [ "Global" ], "summary": "Retrieves the registration url for use by the extension", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/group/create": { "post": { "tags": [ "Group" ], "summary": "Creates a group", "requestBody": { "description": "The create group payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Create" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Create" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Create" } } } }, "responses": { "200": { "description": "Successfully created group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResponse" } } } }, "400": { "description": "Failed payload validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "406": { "description": "Reached maximum threshold of groups or requested id is already present", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/list": { "get": { "tags": [ "Group" ], "summary": "Retrieves a list of all groups you are a part of", "responses": { "200": { "description": "Retrieved list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDetailResponse" } } } } }, "401": { "description": "Not authenticated" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/list/owner": { "get": { "tags": [ "Group" ], "summary": "Retrieves a list of all groups you own", "responses": { "200": { "description": "Retrieved list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDetailResponse" } } } } }, "401": { "description": "Not authenticated" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/list/admin": { "get": { "tags": [ "Group" ], "summary": "Retrieves a list of all groups you are an administrator of", "responses": { "200": { "description": "Retrieved list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDetailResponse" } } } } }, "401": { "description": "Not authenticated" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/list/member": { "get": { "tags": [ "Group" ], "summary": "Retrieves a list of all groups you are a member of", "responses": { "200": { "description": "Retrieved list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDetailResponse" } } } } }, "401": { "description": "Not authenticated" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/{GroupId}": { "get": { "tags": [ "Group" ], "summary": "Retrives a group given a GroupId", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDetailResponse" } } } }, "400": { "description": "Invalid GroupId" }, "401": { "description": "Not authenticated" }, "403": { "description": "You are not a member of this group" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/list/invite": { "get": { "tags": [ "Group" ], "summary": "Retrieves all pending invites", "responses": { "200": { "description": "Succses", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InviteResponse" } } } } }, "401": { "description": "Not authenticated" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/invite/accept/{GroupId}": { "put": { "tags": [ "Group" ], "summary": "Accepts a group invite", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId to accept the invite to", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid GroupId" }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found or you do not have an invite from GroupId specified" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/invite/reject/{GroupId}": { "put": { "tags": [ "Group" ], "summary": "Rejects a group invite", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId to reject the invite to", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid GroupId" }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found or you do not have an invite from GroupId specified" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/invite": { "post": { "tags": [ "Group" ], "summary": "Invites users to a group you own or are admin of", "requestBody": { "description": "Invite payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invite" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invite" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Invite" } } } }, "responses": { "200": { "description": "Successfully invited specified users" }, "400": { "description": "Failed payload validation or trying to invite as admin as non-owner", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found or you are not the owner or admin of the GroupId specified" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/leave/{GroupId}": { "put": { "tags": [ "Group" ], "summary": "Leave a group", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId to leave", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully left group" }, "400": { "description": "Failed payload validation or attempting to leave when you are owner" }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found or you are not a member of the group" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/kick/{GroupId}/{UserName}": { "put": { "tags": [ "Group" ], "summary": "Kicks a user from the given GroupId", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "UserName", "in": "path", "description": "The UserName to kick", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully invited specified users" }, "400": { "description": "Failed payload validation or attempting to use when you don't have permission", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found, you are not the owner or admin of the GroupId specified, or the user was not found in the group", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/promote/{GroupId}/{UserName}": { "put": { "tags": [ "Group" ], "summary": "Promotes a the provided UserName in the provided GroupId", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "UserName", "in": "path", "description": "The UserName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully promoted specified user", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Failed payload validation or invalid operation", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found, you are not the owner of the GroupId specified, or the username specified is not in the group", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/group/delete/{GroupId}": { "delete": { "tags": [ "Group" ], "summary": "Deletes a group you own", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted group" }, "400": { "description": "Invalid id", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "GroupId not found or you are not the owner of the GroupId specified", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/infrastructure": { "put": { "tags": [ "Infrastructure" ], "summary": "PUTs a PATH_PROJECT payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_PROJECT" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_PROJECT" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_PROJECT" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Infrastructure" ], "summary": "Retrieves infrastructure projects", "parameters": [ { "name": "infrastructure", "in": "query", "description": "List of infrastructure ids, planet names, planet ids, or planet natural ids", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_contributions", "in": "query", "description": "If contributions should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_upkeeps", "in": "query", "description": "If upkeeps should be returned", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfrastructureProject" } } } } }, "400": { "description": "Bad input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/localmarket": { "put": { "tags": [ "LocalMarket" ], "summary": "Puts the PATH_LOCALMARKET_AD payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "LocalMarket" ], "summary": "Retrives all LM ads", "parameters": [ { "name": "include_buys", "in": "query", "description": "If we should emit buys", "schema": { "type": "boolean", "default": true } }, { "name": "include_sells", "in": "query", "description": "If we should emit sells", "schema": { "type": "boolean", "default": true } }, { "name": "include_shipments", "in": "query", "description": "If we should emit shipments", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalMarketAd" } } } } } } } }, "/localmarket/{LocalMarketIdentifier}": { "get": { "tags": [ "LocalMarket" ], "summary": "Retrieves LM ads", "parameters": [ { "name": "LocalMarketIdentifier", "in": "path", "description": "The Planet/Station Id/NaturalId/name", "required": true, "schema": { "type": "string" } }, { "name": "include_buys", "in": "query", "description": "If we should emit buys", "schema": { "type": "boolean", "default": true } }, { "name": "include_sells", "in": "query", "description": "If we should emit sells", "schema": { "type": "boolean", "default": true } }, { "name": "include_shipments", "in": "query", "description": "If we should emit shipments", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalMarketAd" } } } } } } } }, "/localmarket/planet": { "get": { "tags": [ "LocalMarket" ], "summary": "Retireves local market adds from the provided planet(s)", "parameters": [ { "name": "planet", "in": "query", "description": "Planet(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_buys", "in": "query", "description": "If buys should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_sells", "in": "query", "description": "If sells should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_shipments", "in": "query", "description": "If shipments should be included", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalMarketAd" } } } }, "400": { "description": "Did not specify any planets or no ad types" } } } }, "/localmarket/{LocalMarketIdentifier}/{LocalMarketAdId}": { "get": { "tags": [ "LocalMarket" ], "summary": "Retrives an indvidual LM ad", "parameters": [ { "name": "LocalMarketIdentifier", "in": "path", "description": "The Planet/Station Id/NaturalId/name", "required": true, "schema": { "type": "string" } }, { "name": "LocalMarketAdId", "in": "path", "description": "The ad's natural id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalMarketAd" } } } }, "404": { "description": "No ad found" } } } }, "/localmarket/company/{CompanyIdentifier}": { "get": { "tags": [ "LocalMarket" ], "summary": "Retrives ads for the provided CompanyIdentifier", "parameters": [ { "name": "CompanyIdentifier", "in": "path", "description": "Company Id, Code, or Name", "required": true, "schema": { "type": "string" } }, { "name": "include_buys", "in": "query", "description": "If buys should be included in the result", "schema": { "type": "boolean", "default": true } }, { "name": "include_sells", "in": "query", "description": "If sells should be included in the result", "schema": { "type": "boolean", "default": true } }, { "name": "include_shipments", "in": "query", "description": "If shipments should be included in the result", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalMarketAd" } } } } } } } }, "/localmarket/shipping": { "get": { "tags": [ "LocalMarket" ], "summary": "Retrieve shipping ads provided a given origin and/or destination. If neither are provided, returns all shipping ads.", "parameters": [ { "name": "origin", "in": "query", "description": "The natural id of the origin", "schema": { "type": "string" } }, { "name": "destination", "in": "query", "description": "The natural id of the destination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalMarketAd" } } } } } } } }, "/map/systemstars": { "put": { "tags": [ "Map" ], "summary": "PUTs the SYSTEM_STARS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SYSTEM_STARS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SYSTEM_STARS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SYSTEM_STARS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key or not an admin" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/map/sectors": { "put": { "tags": [ "Map" ], "summary": "PUTs the MAP_WORLD_SECTORS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key or not an admin" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Map" ], "summary": "Get all sectors", "parameters": [ { "name": "include_subsectors", "in": "query", "description": "Whether the payload should include subsectors", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sector" } } } } } } } }, "/map/system": { "put": { "tags": [ "Map" ], "summary": "PUTs the MAP_SYSTEM payload", "requestBody": { "description": "SystemData", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MAP_SYSTEM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MAP_SYSTEM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MAP_SYSTEM" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/map/sectors/{SearchIdentifier}": { "get": { "tags": [ "Map" ], "summary": "Gets sectors by search", "parameters": [ { "name": "SearchIdentifier", "in": "path", "description": "SectorId or Name (can be partial name)", "required": true, "schema": { "type": "string" } }, { "name": "include_subsectors", "in": "query", "description": "Whether the payload should include subsectors", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sector" } } } } } } } }, "/map/systems": { "get": { "tags": [ "Map" ], "summary": "Gets all systems with a search", "parameters": [ { "name": "system", "in": "query", "description": "[Optional] SystemId, Name, or NaturalId (can be partial)", "schema": { "type": "string" } }, { "name": "include_celestial_bodies", "in": "query", "description": "If celestial bodies should be returned with the results", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/System" } } } } } } } }, "/map/stars/{SearchIdentifier}": { "get": { "tags": [ "Map" ], "summary": "Get all stars that match the provided SearchIdentifier", "parameters": [ { "name": "SearchIdentifier", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Star" } } } } } } } }, "/map/stars": { "get": { "tags": [ "Map" ], "summary": "Get all stars", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Star" } } } } } } } }, "/map/jumproute/{Source}/{Destination}": { "get": { "tags": [ "Map" ], "summary": "Retrieves a jump route from a provided source and destination", "parameters": [ { "name": "Source", "in": "path", "description": "Source", "required": true, "schema": { "type": "string" } }, { "name": "Destination", "in": "path", "description": "Destination", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JumpCacheRouteJump" } } } } }, "400": { "description": "Failed to resolve source/destination", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/map/jumpcount/{Source}/{Destination}": { "get": { "tags": [ "Map" ], "summary": "Retrieves the number of jumps for a given source and destination", "parameters": [ { "name": "Source", "in": "path", "description": "Source", "required": true, "schema": { "type": "string" } }, { "name": "Destination", "in": "path", "description": "Destination", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/text": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Failed to resolve source/destination", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/material": { "put": { "tags": [ "Material" ], "summary": "PUTs the materials payload", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Material" ], "summary": "Retrieves materials given the provided parameters. If no parameters given, returns all materials.", "parameters": [ { "name": "id", "in": "query", "description": "material id(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ticker", "in": "query", "description": "material ticker(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "name", "in": "query", "description": "material name(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "category_id", "in": "query", "description": "category id(s)", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Material" } } } } }, "400": { "description": "Invalid GET parameter(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/material/category": { "put": { "tags": [ "Material" ], "summary": "PUTs the material categories payload", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/material/resources": { "get": { "tags": [ "Material" ], "summary": "Retrieves a list of materials which are resources (extractable from a planet)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Material" } } } } } } } }, "/material/categories": { "get": { "tags": [ "Material" ], "summary": "Retrieves a list of material categories", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialCategory" } } } } } } } }, "/permission": { "get": { "tags": [ "Permission" ], "summary": "Retrieves grantor permissions - Permissions YOU have granted to others", "description": "Note that this will NOT include groups you are in", "responses": { "200": { "description": "Successfully retrieved grantor permission", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionResponse" } } } } }, "401": { "description": "Not authorized" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/permission/granted": { "get": { "tags": [ "Permission" ], "summary": "Retrieves granted permissions - Permissions granted TO you from others", "responses": { "200": { "description": "Successfully retrieved granted permissions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionResponse" } } } } }, "401": { "description": "Not authorized" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/permission/group/{GroupId}": { "get": { "tags": [ "Permission" ], "summary": "Retrieves the provided GroupId's permissions", "parameters": [ { "name": "GroupId", "in": "path", "description": "GroupId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved permissions for GroupId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Permissions" } } } }, "400": { "description": "Invalid GroupId specified" }, "401": { "description": "Not authorized" }, "404": { "description": "GroupId not found or you are not a member of the group" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/permission/groupidavailable/{GroupId}": { "get": { "tags": [ "Permission" ], "summary": "Retrieves if the provided GroupId is available", "parameters": [ { "name": "GroupId", "in": "path", "description": "The GroupId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "GroupId is available" }, "204": { "description": "GroupId is not available" }, "400": { "description": "Invalid GroupId specified" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/permission/grant": { "put": { "tags": [ "Permission" ], "summary": "Grants permission to another user for your data", "description": "You can use this to update an existing permission", "requestBody": { "description": "The grant payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Grant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Grant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Grant" } } } }, "responses": { "200": { "description": "Successfully granted permissions" }, "400": { "description": "Failed payload validation" }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "Username not found" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/permission/revoke/{Grantee}": { "delete": { "tags": [ "Permission" ], "summary": "Revokes the specified Grantee permission", "parameters": [ { "name": "Grantee", "in": "path", "description": "The grantee to revoke", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully granted permissions" }, "400": { "description": "Failed payload validation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not authenticated" }, "403": { "description": "Improperly using a read-only APIKey" }, "404": { "description": "Grantee username not found" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/planet": { "put": { "tags": [ "Planet" ], "summary": "PUTs the planet payload (PATH_PLANETS) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATH_PLANETS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PATH_PLANETS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PATH_PLANETS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Planet" ], "summary": "Retrieves specified planet(s) by name, naturalid, or planet id", "parameters": [ { "name": "planet", "in": "query", "description": "Planet(s) to search", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_resources", "in": "query", "description": "If the resources should be returned", "schema": { "type": "boolean", "default": true } }, { "name": "include_workforce_fees", "in": "query", "description": "If the workforce fees should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_cogc_programs", "in": "query", "description": "If COGC data should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_population_reports", "in": "query", "description": "If population reports should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_celestial_bodies", "in": "query", "description": "If celestial bodies should be returned", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Planet" } } } } }, "400": { "description": "Did not specify any planets" } } } }, "/planet/sites": { "put": { "tags": [ "Planet" ], "summary": "PUTs the planet sites payload (PLANET_SITES) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PLANET_SITES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PLANET_SITES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PLANET_SITES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/planet/cogc": { "put": { "tags": [ "Planet" ], "summary": "PUTs the planet cogc history payload (PLANET_COGC_HISTORY) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/planet/population": { "put": { "tags": [ "Planet" ], "summary": "PUTs the planet population report payload (PLANET_POPULATION_REPORT) to FIOAPI", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/planet/sites/{PlanetIdentifier}": { "get": { "tags": [ "Planet" ], "summary": "Retrieves all sites for a provided planet identifier", "parameters": [ { "name": "PlanetIdentifier", "in": "path", "description": "Planet identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetSite" } } } } }, "400": { "description": "PlanetIdentifier not valid", "content": { "plain/text": { "schema": { "type": "string" } } } } } } }, "/planet/sitecount": { "get": { "tags": [ "Planet" ], "summary": "Retrieves site count. Optional planets can be specified.", "parameters": [ { "name": "planet", "in": "query", "description": "Planet names/natural ids/ids", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_non_player_sites", "in": "query", "description": "If non-player sites should be factored in", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetSiteCount" } } } } } } } }, "/planet/{PlanetIdentifier}": { "get": { "tags": [ "Planet" ], "summary": "Retrieves the specified planet by name, naturalid, or planet id", "parameters": [ { "name": "PlanetIdentifier", "in": "path", "description": "Name, NaturalId, or Planet id", "required": true, "schema": { "type": "string" } }, { "name": "include_resources", "in": "query", "description": "If the resources should be returned", "schema": { "type": "boolean", "default": true } }, { "name": "include_workforce_fees", "in": "query", "description": "If the workforce fees should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_cogc_programs", "in": "query", "description": "If COGC data should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_population_reports", "in": "query", "description": "If population reports should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_celestial_bodies", "in": "query", "description": "If celestial bodies should be returned", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Planet" } } } }, "204": { "description": "Not found" } } } }, "/planet/all_planets": { "get": { "tags": [ "Planet" ], "summary": "Retrieves all planets", "parameters": [ { "name": "include_resources", "in": "query", "description": "If the resources should be returned", "schema": { "type": "boolean", "default": true } }, { "name": "include_workforce_fees", "in": "query", "description": "If the workforce fees should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_cogc_programs", "in": "query", "description": "If COGC data should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_population_reports", "in": "query", "description": "If population reports should be returned", "schema": { "type": "boolean", "default": false } }, { "name": "include_celestial_bodies", "in": "query", "description": "If celestial bodies should be returned", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Planet" } } } } } } } }, "/planet/search": { "post": { "tags": [ "Planet" ], "summary": "Searches planets", "requestBody": { "description": "The search payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanetSearch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanetSearch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanetSearch" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetSearchResult" } } } } }, "400": { "description": "Failed to search", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/productionline": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs SITE_PRODUCTION_LINES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "ProductionLine" ], "summary": "Retrieves ProductionLines for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "include_orders", "in": "query", "description": "If orders should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionLineListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/updated": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/msg_updated": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs MESG_PRODUCTION_PRODUCTION_LINE payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/order/added": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs ROOT_PRODUCTION_ORDER_ADDED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_ADDED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_ADDED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_ADDED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/order/msg_added": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs MESG_PRODUCTION_ORDER_ADDED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_ADDED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_ADDED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_ADDED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/order/updated": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs ROOT_PRODUCTION_ORDER_UPDATED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_UPDATED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_UPDATED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_UPDATED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/order/removed": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs ROOT_PRODUCTION_ORDER_REMOVED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_REMOVED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_REMOVED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_REMOVED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/productionline/order/msg_removed": { "put": { "tags": [ "ProductionLine" ], "summary": "PUTs MESG_PRODUCTION_ORDER_REMOVED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_REMOVED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_REMOVED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_REMOVED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/ships": { "put": { "tags": [ "Ships" ], "summary": "PUTs MESG_SHIP_SHIPS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Ships" ], "summary": "Retrieves ships for the provided UserName", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ship_id", "in": "query", "description": "[Optional] Provided ShipID(s) or Registration(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "include_repair_materials", "in": "query", "description": "If repair materials should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/ships/flights": { "put": { "tags": [ "Ships" ], "summary": "PUTs MESG_SHIP_FLIGHT_FLIGHTS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Ships" ], "summary": "GetFlights", "parameters": [ { "name": "username", "in": "query", "description": "username array", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "group", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/sites": { "put": { "tags": [ "Sites" ], "summary": "PUTs ROOT_SITE_SITES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_SITES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_SITES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_SITES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/msg_sites": { "put": { "tags": [ "Sites" ], "summary": "PUTs MESG_SITE_SITES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_SITE_SITES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_SITE_SITES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_SITE_SITES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/built": { "put": { "tags": [ "Sites" ], "summary": "PUTs ROOT_SITE_PLATFORM_BUILT payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_BUILT" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_BUILT" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_BUILT" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/msg_removed": { "put": { "tags": [ "Sites" ], "summary": "PUTs MESG_SITE_PLATFORM_REMOVED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_SITE_PLATFORM_REMOVED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_SITE_PLATFORM_REMOVED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_SITE_PLATFORM_REMOVED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/removed": { "put": { "tags": [ "Sites" ], "summary": "PUTs ROOT_SITE_PLATFORM_REMOVED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_REMOVED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_REMOVED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_REMOVED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/updated": { "put": { "tags": [ "Sites" ], "summary": "PUTs the ROOT_SITE_PLATFORM_UPDATED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_UPDATED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_UPDATED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_UPDATED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/experts": { "put": { "tags": [ "Sites" ], "summary": "PUTs the MESG_EXPERTS_EXPERTS payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Sites" ], "summary": "Retrieves Experts for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "The group", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/workforces": { "put": { "tags": [ "Sites" ], "summary": "PUTs the WORKFORCE_WORKFORCES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Sites" ], "summary": "Retrieves Workforces for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "The group", "schema": { "type": "string" } }, { "name": "include_needs", "in": "query", "description": "If workforce needs should be included", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites/workforces/updated": { "put": { "tags": [ "Sites" ], "summary": "PUTs the ROOT_WORKFORCE_WORKFORCES_UPDATED payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_WORKFORCE_WORKFORCES_UPDATED" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_WORKFORCE_WORKFORCES_UPDATED" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_WORKFORCE_WORKFORCES_UPDATED" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/sites": { "get": { "tags": [ "Sites" ], "summary": "Retrieves Sites for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "The group", "schema": { "type": "string" } }, { "name": "include_buildings", "in": "query", "description": "If buildings should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/storage": { "put": { "tags": [ "Storage" ], "summary": "PUTs STORAGE_STORAGES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/STORAGE_STORAGES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/STORAGE_STORAGES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/STORAGE_STORAGES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] }, "get": { "tags": [ "Storage" ], "summary": "Retrieves Storages for the provided UserName(s)", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "include_bases", "in": "query", "description": "If bases should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_warehouses", "in": "query", "description": "If warehouses should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_ship_stores", "in": "query", "description": "If ship stores should be included", "schema": { "type": "boolean", "default": true } }, { "name": "include_ship_stl_stores", "in": "query", "description": "If ship stl fuel stores should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_ship_ftl_stores", "in": "query", "description": "If ship ftl fuel stores should be included", "schema": { "type": "boolean", "default": false } }, { "name": "include_items", "in": "query", "description": "If items should be included", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageListRetrievalResponse" } } } }, "400": { "description": "Malformed input", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/storage/change": { "put": { "tags": [ "Storage" ], "summary": "PUTs ROOT_STORAGE_CHANGE payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ROOT_STORAGE_CHANGE" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ROOT_STORAGE_CHANGE" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ROOT_STORAGE_CHANGE" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/storage/warehouses": { "put": { "tags": [ "Storage" ], "summary": "PUTs WAREHOUSE_STORAGES payload", "requestBody": { "description": "The payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES" } } } }, "responses": { "200": { "description": "Payload accepted" }, "400": { "description": "Payload malformed", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Improperly using a read-only API key" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } }, "/storage/warehouseinfo": { "get": { "tags": [ "Storage" ], "summary": "Retrieves warehouse information for the provided UserName(s) / group", "parameters": [ { "name": "username", "in": "query", "description": "Provided user(s)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "group", "in": "query", "description": "Group", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageListRetrievalResponse" } } } }, "401": { "description": "Not logged in" }, "403": { "description": "Don't have read access" } }, "security": [ { "Bearer": [ ], "FIOAPIKey": [ ] } ] } } }, "components": { "schemas": { "APEX_COMMON_ADDRESS": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_LINE" } } }, "additionalProperties": false }, "APEX_COMMON_ADDRESS_ENTITY": { "type": "object", "properties": { "id": { "type": "string" }, "naturalId": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "APEX_COMMON_ADDRESS_LINE": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_ENTITY" }, "type": { "type": "string" } }, "additionalProperties": false }, "APEX_COMMON_ADDRESS_LINE_WITH_ORBIT": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_ENTITY" }, "type": { "type": "string" }, "orbit": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_ORBIT" } }, "additionalProperties": false }, "APEX_COMMON_ADDRESS_ORBIT": { "type": "object", "properties": { "semiMajorAxis": { "type": "number", "format": "double" }, "eccentricity": { "type": "number", "format": "double" }, "inclination": { "type": "number", "format": "double" }, "rightAscension": { "type": "number", "format": "double" }, "periapsis": { "type": "number", "format": "double" } }, "additionalProperties": false }, "APEX_COMMON_ADDRESS_WITH_ORBIT": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_LINE_WITH_ORBIT" } } }, "additionalProperties": false }, "APEX_COMMON_AMOUNT_AND_CURRENCY": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "APEX_COMMON_CURRENCY": { "type": "object", "properties": { "numericCode": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" }, "code": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "decimals": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "APEX_COMMON_DURATION": { "type": "object", "properties": { "millis": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "APEX_COMMON_MATERIAL": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "id": { "type": "string" }, "ticker": { "type": "string" }, "category": { "type": "string" }, "weight": { "maximum": 50000, "minimum": 1E-05, "type": "number", "format": "double" }, "volume": { "maximum": 50000, "minimum": 1E-05, "type": "number", "format": "double" }, "resource": { "type": "boolean" } }, "additionalProperties": false }, "APEX_COMMON_MATERIAL_AND_AMOUNT": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "APEX_COMMON_TIMESTAMP": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "APEX_COMMON_USER": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "maxLength": 32, "minLength": 2, "type": "string" }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "APEX_COMMON_USER_AND_CODE": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "code": { "maxLength": 4, "minLength": 1, "type": "string", "nullable": true }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "APEX_COMMON_USER_AND_CODE_NULLABLE": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "maxLength": 64, "minLength": 2, "type": "string", "nullable": true }, "code": { "maxLength": 4, "minLength": 1, "type": "string", "nullable": true }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "APIKey": { "type": "object", "properties": { "Key": { "type": "string", "description": "The actual Key to use", "format": "uuid" }, "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "The username owner" }, "Application": { "maxLength": 128, "minLength": 0, "type": "string", "description": "The application name", "default": "" }, "AllowWrites": { "type": "boolean", "description": "If this APIKey should allow writes", "default": false }, "CreateTime": { "type": "string", "description": "The time of APIKey creation in Utc", "format": "date-time" } }, "additionalProperties": false, "description": "APIKey model" }, "AllData": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/Company" }, "Contracts": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" }, "description": "Contracts", "nullable": true }, "CXOSs": { "type": "array", "items": { "$ref": "#/components/schemas/CXOS" }, "description": "CXOSs", "nullable": true }, "ProductionLines": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionLine" }, "description": "ProductionLines", "nullable": true }, "Ships": { "type": "array", "items": { "$ref": "#/components/schemas/Ship" }, "description": "Ships", "nullable": true }, "Flights": { "type": "array", "items": { "$ref": "#/components/schemas/Flight" }, "description": "Flights", "nullable": true }, "Sites": { "type": "array", "items": { "$ref": "#/components/schemas/Site" }, "description": "Sites", "nullable": true }, "Storages": { "type": "array", "items": { "$ref": "#/components/schemas/Storage" }, "description": "Storages", "nullable": true }, "Workforces": { "type": "array", "items": { "$ref": "#/components/schemas/Workforce" }, "description": "Workforces", "nullable": true } }, "additionalProperties": false, "description": "An \"AllData\" payload - All available data on the user" }, "AllDataIndividualUserResponse": { "title": "IndividualUserResponse", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "$ref": "#/components/schemas/AllData" } }, "additionalProperties": false, "description": "An individual response" }, "AllDataRetrievalResponse": { "title": "RetrievalResponse", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AllDataIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "AutoRequestRegister": { "type": "object", "properties": { "messageType": { "type": "string", "description": "messageType" }, "payload": { "$ref": "#/components/schemas/AutoRequestRegisterPayload" } }, "additionalProperties": false, "description": "AutoRequestRegister" }, "AutoRequestRegisterPayload": { "type": "object", "properties": { "username": { "maxLength": 32, "minLength": 3, "type": "string", "description": "username", "example": "Saganaki" }, "admin": { "type": "boolean", "description": "admin", "default": false } }, "additionalProperties": false, "description": "Inner payload" }, "AutoRequestRegisterResponse": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "The username (case-sensitive) for the request", "example": "Saganaki" }, "RegistrationGuid": { "type": "string", "description": "The registration guid to use", "format": "uuid", "example": "a568f64a66414c959dace10e47294855" }, "RegistrationTime": { "type": "string", "description": "The time when registration was requested", "format": "date-time" } }, "additionalProperties": false, "description": "Response for AutoRequestRgister" }, "Building": { "type": "object", "properties": { "BuildingId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "BuildingId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "The name of the building" }, "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "The ticker of the building" }, "Expertise": { "maxLength": 19, "minLength": 9, "type": "string", "description": "The expertise of this building", "nullable": true }, "Pioneers": { "maximum": 200, "minimum": 0, "type": "integer", "description": "The number of pioneers this building uses", "format": "int32" }, "Settlers": { "maximum": 200, "minimum": 0, "type": "integer", "description": "The number of settlers this building uses", "format": "int32" }, "Technicians": { "maximum": 200, "minimum": 0, "type": "integer", "description": "The number of technicians this building uses", "format": "int32" }, "Engineers": { "maximum": 200, "minimum": 0, "type": "integer", "description": "The number of engineers this building uses", "format": "int32" }, "Scientists": { "maximum": 200, "minimum": 0, "type": "integer", "description": "The number of scientists this building uses", "format": "int32" }, "AreaCost": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "The area cost of this building", "format": "int32" }, "Costs": { "type": "array", "items": { "$ref": "#/components/schemas/BuildingCost" }, "description": "The costs of the building" }, "Recipes": { "type": "array", "items": { "$ref": "#/components/schemas/BuildingRecipe" }, "description": "Recipes for the building" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true } }, "additionalProperties": false, "description": "Building Model" }, "BuildingCost": { "type": "object", "properties": { "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "The name of the material" }, "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "The ticker of the material" }, "Weight": { "maximum": 50000, "minimum": 1E-05, "type": "number", "description": "Weight of the material", "format": "double" }, "Volume": { "maximum": 50000, "minimum": 1E-05, "type": "number", "description": "Volume of the material", "format": "double" }, "Amount": { "maximum": 5000, "minimum": 1, "type": "integer", "description": "The amount of the material required", "format": "int32" } }, "additionalProperties": false, "description": "BuildingCost" }, "BuildingRecipe": { "type": "object", "properties": { "BuildingRecipeId": { "maxLength": 100, "minLength": 0, "type": "string", "description": "BuildingRecipeId" }, "DurationMs": { "type": "integer", "description": "Duration of the recipe in milliseconds", "format": "int64" }, "Inputs": { "type": "array", "items": { "$ref": "#/components/schemas/BuildingRecipeInput" }, "description": "Inputs for a recipe" }, "Outputs": { "type": "array", "items": { "$ref": "#/components/schemas/BuildingRecipeOutput" }, "description": "Outputs for a recipe" } }, "additionalProperties": false, "description": "BuidlingRecipe" }, "BuildingRecipeInput": { "type": "object", "properties": { "Id": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Id of the material" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name of the material" }, "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Ticker of the material" }, "Weight": { "maximum": 50000, "minimum": 1E-05, "type": "number", "description": "Weight of the material", "format": "double" }, "Volume": { "maximum": 50000, "minimum": 1E-05, "type": "number", "description": "Volume of the material", "format": "double" }, "Amount": { "maximum": 5000, "minimum": 1, "type": "integer", "description": "Amount of the material", "format": "int32" } }, "additionalProperties": false, "description": "BuildingRecipeInput" }, "BuildingRecipeOutput": { "type": "object", "properties": { "Id": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Id of the material" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name of the material" }, "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Ticker of the material" }, "Weight": { "maximum": 50000, "minimum": 1E-05, "type": "number", "description": "Weight of the material", "format": "double" }, "Volume": { "maximum": 50000, "minimum": 1E-05, "type": "number", "description": "Volume of the material", "format": "double" }, "Amount": { "maximum": 5000, "minimum": 1, "type": "integer", "description": "Amount of the material", "format": "int32" } }, "additionalProperties": false, "description": "BuildingRecipeMaterial" }, "Burn": { "type": "object", "properties": { "PlanetId": { "type": "string", "description": "PlanetId" }, "PlanetNaturalId": { "type": "string", "description": "PlanetNaturalId" }, "PlanetName": { "type": "string", "description": "PlanetName", "nullable": true }, "WorkforceConsumptionTime": { "type": "string", "description": "WorkforceConsumptionTime", "format": "date-time", "nullable": true }, "LastUpdate": { "type": "string", "description": "LastUpdate", "format": "date-time", "nullable": true }, "Inventory": { "type": "array", "items": { "$ref": "#/components/schemas/BurnItem" }, "description": "Inventory" } }, "additionalProperties": false, "description": "Burn" }, "BurnItem": { "type": "object", "properties": { "MaterialTicker": { "type": "string", "description": "MaterialTicker" }, "MaterialAmount": { "type": "integer", "description": "MaterialAmount", "format": "int32" }, "WorkforceConsumption": { "type": "number", "description": "WorkforceConsumption", "format": "double" }, "OrderConsumption": { "type": "number", "description": "OrderConsumption", "format": "double" }, "OrderProduction": { "type": "number", "description": "OrderProduction", "format": "double" }, "OverallDelta": { "type": "number", "description": "OverallDelta", "format": "double" } }, "additionalProperties": false, "description": "BurnItem" }, "BurnListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Burn" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "BurnListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BurnListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "CHANNEL_MESSAGE_DELETED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_DELETED_PAYLOAD" } }, "additionalProperties": false }, "CHANNEL_MESSAGE_DELETED_PAYLOAD": { "type": "object", "properties": { "messageId": { "type": "string" }, "type": { "maxLength": 32, "minLength": 2, "type": "string" }, "sender": { "$ref": "#/components/schemas/APEX_COMMON_USER" }, "message": { "maxLength": 1024, "minLength": 0, "type": "string" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "channelId": { "type": "string" }, "deletingUser": { "$ref": "#/components/schemas/APEX_COMMON_USER" } }, "additionalProperties": false }, "CHANNEL_MESSAGE_LIST": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST_PAYLOAD_OUTER" } }, "additionalProperties": false }, "CHANNEL_MESSAGE_LIST_MESSAGE_INNER": { "type": "object", "properties": { "messageId": { "type": "string" }, "type": { "maxLength": 32, "minLength": 2, "type": "string" }, "sender": { "$ref": "#/components/schemas/APEX_COMMON_USER" }, "message": { "maxLength": 1024, "minLength": 0, "type": "string", "nullable": true }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "channelId": { "type": "string" }, "deletingUser": { "$ref": "#/components/schemas/APEX_COMMON_USER" } }, "additionalProperties": false }, "CHANNEL_MESSAGE_LIST_MESSAGE_OUTER": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST_PAYLOAD_INNER" } }, "additionalProperties": false }, "CHANNEL_MESSAGE_LIST_PAYLOAD_INNER": { "type": "object", "properties": { "channelId": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST_MESSAGE_INNER" } }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "CHANNEL_MESSAGE_LIST_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/CHANNEL_MESSAGE_LIST_MESSAGE_OUTER" } }, "additionalProperties": false }, "CHANNEL_USER_JOINED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CHANNEL_USER_JOINED_PAYLOAD" } }, "additionalProperties": false }, "CHANNEL_USER_JOINED_PAYLOAD": { "type": "object", "properties": { "channelId": { "type": "string" }, "user": { "$ref": "#/components/schemas/CHANNEL_USER_JOINED_USER" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "messageId": { "type": "string" } }, "additionalProperties": false }, "CHANNEL_USER_JOINED_USER": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/APEX_COMMON_USER" } }, "additionalProperties": false }, "CHANNEL_USER_LEFT": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CHANNEL_USER_LEFT_PAYLOAD" } }, "additionalProperties": false }, "CHANNEL_USER_LEFT_PAYLOAD": { "type": "object", "properties": { "channelId": { "type": "string" }, "user": { "$ref": "#/components/schemas/CHANNEL_USER_LEFT_USER" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "messageId": { "type": "string" } }, "additionalProperties": false }, "CHANNEL_USER_LEFT_USER": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/CHANNEL_USER_LEFT_USER_DETAILS" } }, "additionalProperties": false }, "CHANNEL_USER_LEFT_USER_DETAILS": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "maxLength": 32, "minLength": 3, "type": "string" }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "CXBuyOrder": { "type": "object", "properties": { "CXBuyOrderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CXBuyOrderId" }, "CompanyId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CompanyId" }, "CompanyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CompanyName" }, "CompanyCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CompanyCode" }, "ItemCount": { "type": "integer", "description": "ItemCount", "format": "int32", "nullable": true }, "ItemCost": { "type": "number", "description": "ItemCost", "format": "double" } }, "additionalProperties": false, "description": "CXBuyOrder" }, "CXEntry": { "type": "object", "properties": { "CXEntryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CXId" }, "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialId" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "ExchangeId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ExchangeId" }, "ExchangeCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ExchangeCode" }, "CurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "CurrencyCode" }, "Price": { "type": "number", "description": "Price", "format": "double", "nullable": true }, "PriceTime": { "type": "string", "description": "PriceTime", "format": "date-time", "nullable": true }, "High": { "type": "number", "description": "High", "format": "double", "nullable": true }, "AllTimeHigh": { "type": "number", "description": "AllTimeHigh", "format": "double", "nullable": true }, "Low": { "type": "number", "description": "Low", "format": "double", "nullable": true }, "AllTimeLow": { "type": "number", "description": "AllTimeLow", "format": "double", "nullable": true }, "Ask": { "type": "number", "description": "", "format": "double", "nullable": true }, "AskCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "AskCount", "format": "int32", "nullable": true }, "Bid": { "type": "number", "description": "Bid", "format": "double", "nullable": true }, "BidCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "BidCount", "format": "int32", "nullable": true }, "Supply": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Supply", "format": "int32", "nullable": true }, "Demand": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Demand", "format": "int32", "nullable": true }, "Traded": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Traded", "format": "int32", "nullable": true }, "Volume": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Volume", "format": "double", "nullable": true }, "PriceAverage": { "type": "number", "description": "PriceAverage", "format": "double", "nullable": true }, "NarrowPriceBandLow": { "type": "number", "description": "NarrowPriceBandLow", "format": "double", "nullable": true }, "NarrowPriceBandHigh": { "type": "number", "description": "NarrowPriceBandHigh", "format": "double", "nullable": true }, "WidePriceBandLow": { "type": "number", "description": "WidePriceBandLow", "format": "double", "nullable": true }, "WidePriceBandHigh": { "type": "number", "description": "WidePriceBandHigh", "format": "double", "nullable": true }, "MMBuy": { "type": "number", "description": "MMBuy", "format": "double", "nullable": true }, "MMSell": { "type": "number", "description": "MMSell", "format": "double", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "BuyOrders": { "type": "array", "items": { "$ref": "#/components/schemas/CXBuyOrder" }, "description": "BuyOrders" }, "SellOrders": { "type": "array", "items": { "$ref": "#/components/schemas/CXSellOrder" }, "description": "SellOrders" } }, "additionalProperties": false, "description": "CX (CXEntry)" }, "CXOS": { "type": "object", "properties": { "OrderId": { "type": "string", "description": "OrderId", "readOnly": true }, "ExchangeCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ExchangeCode" }, "BrokerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "BrokerId" }, "OrderType": { "maxLength": 7, "minLength": 6, "type": "string", "description": "OrderType" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "Amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Amount", "format": "int32" }, "InitialAmount": { "type": "integer", "description": "InitialAmount", "format": "int32" }, "LimitAmount": { "type": "number", "description": "LimitAmount", "format": "double" }, "LimitCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "LimitCurrency" }, "Status": { "maxLength": 32, "minLength": 4, "type": "string", "description": "Status" }, "Created": { "type": "string", "description": "Created", "format": "date-time" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "Trades": { "type": "array", "items": { "$ref": "#/components/schemas/CXOSTrade" }, "description": "Trades" } }, "additionalProperties": false, "description": "CXOS" }, "CXOSListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/CXOS" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "CXOSListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CXOSListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "CXOSTrade": { "type": "object", "properties": { "TradeId": { "type": "string", "description": "TradeId", "readOnly": true }, "Amount": { "type": "integer", "description": "Amount", "format": "int32" }, "PriceAmount": { "type": "number", "description": "PriceAmount", "format": "double" }, "PriceCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "PriceCurrency" }, "Time": { "type": "string", "description": "Time", "format": "date-time" }, "PartnerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PartnerId" }, "PartnerCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "PartnerCode", "nullable": true }, "PartnerName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PartnerName" } }, "additionalProperties": false, "description": "CXOSTrade" }, "CXOSTradeHistorical": { "type": "object", "properties": { "TradeId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "TradeId" }, "ExchangeCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ExchangeCode" }, "BrokerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "BrokerId" }, "OrderType": { "maxLength": 7, "minLength": 6, "type": "string", "description": "OrderType" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "Amount": { "type": "integer", "description": "Amount", "format": "int32" }, "PriceAmount": { "type": "number", "description": "PriceAmount", "format": "double" }, "PriceCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "PriceCurrency" }, "Time": { "type": "string", "description": "Time", "format": "date-time" }, "PartnerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PartnerId" }, "PartnerCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "PartnerCode", "nullable": true }, "PartnerName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PartnerName" }, "Created": { "type": "string", "description": "Created", "format": "date-time" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "CXOSTrade (Historical data)" }, "CXOSTradeHistoricalListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/CXOSTradeHistorical" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "CXOSTradeHistoricalListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CXOSTradeHistoricalListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "CXPC": { "type": "object", "properties": { "BrokerId": { "type": "string", "description": "BrokerId", "readOnly": true }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "ExchangeCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ExchangeCode" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "Entries": { "type": "array", "items": { "$ref": "#/components/schemas/CXPCEntry" }, "description": "Entries" } }, "additionalProperties": false, "description": "CXPC" }, "CXPCEntry": { "type": "object", "properties": { "Interval": { "maxLength": 14, "minLength": 7, "type": "string", "description": "Interval" }, "Date": { "type": "string", "description": "Date", "format": "date-time", "readOnly": true }, "Open": { "type": "number", "description": "Open", "format": "double" }, "Close": { "type": "number", "description": "Close", "format": "double" }, "High": { "type": "number", "description": "High", "format": "double" }, "Low": { "type": "number", "description": "Low", "format": "double" }, "Volume": { "type": "number", "description": "Volume", "format": "double" }, "Traded": { "type": "integer", "description": "Traded", "format": "int32" } }, "additionalProperties": false, "description": "CXPCEntry" }, "CXSellOrder": { "type": "object", "properties": { "CXSellOrderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CXSellOrderId" }, "CompanyId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CompanyId" }, "CompanyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CompanyName" }, "CompanyCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CompanyCode" }, "ItemCount": { "type": "integer", "description": "ItemCount", "format": "int32", "nullable": true }, "ItemCost": { "type": "number", "description": "ItemCost", "format": "double" } }, "additionalProperties": false, "description": "CXSellOrder" }, "CX_PRICES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CX_PRICES_PAYLOAD" } }, "additionalProperties": false }, "CX_PRICES_ASK_OR_BID": { "type": "object", "properties": { "price": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "amount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CX_PRICES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/CX_PRICES_PAYLOAD_INNER" } }, "additionalProperties": false }, "CX_PRICES_ORDER": { "type": "object", "properties": { "id": { "type": "string" }, "trader": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "amount": { "type": "integer", "format": "int32", "nullable": true }, "limit": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" } }, "additionalProperties": false }, "CX_PRICES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/CX_PRICES_MESSAGE" } }, "additionalProperties": false }, "CX_PRICES_PAYLOAD_INNER": { "type": "object", "properties": { "id": { "type": "string" }, "ticker": { "maxLength": 8, "minLength": 5, "type": "string" }, "exchange": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "price": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "priceTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "high": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "allTimeHigh": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "low": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "allTimeLow": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "ask": { "$ref": "#/components/schemas/CX_PRICES_ASK_OR_BID" }, "bid": { "$ref": "#/components/schemas/CX_PRICES_ASK_OR_BID" }, "supply": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "demand": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "traded": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "volume": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "priceAverage": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "narrowPriceBand": { "$ref": "#/components/schemas/CX_PRICES_PRICE_BAND" }, "widePriceBand": { "$ref": "#/components/schemas/CX_PRICES_PRICE_BAND" }, "sellingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/CX_PRICES_ORDER" } }, "buyingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/CX_PRICES_ORDER" } } }, "additionalProperties": false }, "CX_PRICES_PRICE_BAND": { "type": "object", "properties": { "low": { "type": "number", "format": "double" }, "high": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ChangePassword": { "type": "object", "properties": { "OldPassword": { "maxLength": 256, "minLength": 3, "type": "string", "description": "Old password", "example": "Hunter2" }, "NewPassword": { "maxLength": 256, "minLength": 3, "type": "string", "description": "New password", "example": "Hunter4" } }, "additionalProperties": false, "description": "The ChangePassword Payload" }, "ChatChannel": { "type": "object", "properties": { "ChatChannelId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "The ChannelId" }, "Type": { "maxLength": 10, "minLength": 5, "type": "string", "description": "Type" }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId", "nullable": true }, "DisplayName": { "maxLength": 64, "minLength": 0, "type": "string", "description": "DisplayName", "nullable": true }, "UserCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "UserCount", "format": "int32" }, "CreationTimestamp": { "type": "integer", "description": "CreationTimestamp", "format": "int64" }, "LastActivityTimestamp": { "type": "integer", "description": "LastActivityTimestamp", "format": "int64" }, "Messages": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" }, "description": "Messages" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "ChatChannel" }, "ChatMessage": { "type": "object", "properties": { "ChatMessageId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ChatMessageId" }, "Type": { "maxLength": 32, "minLength": 2, "type": "string", "description": "Type" }, "SenderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SenderId" }, "SenderUserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "SenderUserName" }, "MessageText": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "MessageText", "nullable": true }, "MessageTimestamp": { "type": "integer", "description": "MessageTimestamp", "format": "int64" }, "MessageDeleted": { "type": "boolean", "description": "MessageDeleted" }, "DeletedByUserId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "DeletedByUserId", "nullable": true }, "DeletedByUserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "DeletedByUserName", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "ChatChannelId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ChatChannelId" } }, "additionalProperties": false, "description": "ChatMessage" }, "ComexExchange": { "type": "object", "properties": { "ComexExchangeId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Exchange Id" }, "Code": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Code" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name of the exchange" }, "Decimals": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Decimals to show", "format": "int32" }, "NumericCode": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "NumericCode", "format": "int32" }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "Exchange NaturalId" }, "SystemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SystemId" }, "SystemName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "SystemName" }, "SystemNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "SystemNaturalId" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "ComexExchange" }, "Company": { "type": "object", "properties": { "CompanyId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CompanyId" }, "Name": { "maxLength": 32, "minLength": 2, "type": "string", "description": "Name" }, "Code": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Code" }, "Founded": { "type": "string", "description": "Founded", "format": "date-time" }, "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" }, "CountryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CountryId" }, "CountryCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CountryCode" }, "CountryName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CountryName" }, "CorporationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CorporationId", "nullable": true }, "CorporationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CorporationName", "nullable": true }, "CorporationCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CorporationCode", "nullable": true }, "CurrentAPEXRepresentationLevel": { "type": "integer", "description": "CurrentAPEXRepresentationLevel", "format": "int32" }, "OverallRating": { "maxLength": 7, "minLength": 1, "type": "string", "description": "OverallRating" }, "RatingsEarliestContract": { "type": "string", "description": "RatingsEarliestContract", "format": "date-time", "nullable": true }, "RatingContractCount": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "RatingContractCount", "format": "int32" }, "ReputationEntityName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "ReputationEntityName", "nullable": true }, "Reputation": { "maximum": 10000, "minimum": -1000, "type": "integer", "description": "Reputation", "format": "int32" }, "Planets": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyPlanet" }, "description": "Planets" }, "Offices": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyOffice" }, "description": "Offices" }, "StartingProfile": { "maxLength": 32, "minLength": 3, "type": "string", "description": "StartingProfile", "nullable": true }, "StartingLocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "StartingLocationId", "nullable": true }, "StartingLocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "StartingLocationNaturalId", "nullable": true }, "StartingLocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "StartingLocationName", "nullable": true }, "HeadquartersLocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "HeadquartersLocationId", "nullable": true }, "HeadquartersLocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "HeadquartersLocationNaturalId", "nullable": true }, "HeadquartersLocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "HeadquartersLocationName", "nullable": true }, "HeadquartersLevel": { "type": "integer", "description": "HeadquartersLevel", "format": "int32", "nullable": true }, "TotalBasePermits": { "type": "integer", "description": "TotalBasePermits", "format": "int32", "nullable": true }, "UsedBasePermits": { "type": "integer", "description": "UsedBasePermits", "format": "int32", "nullable": true }, "AdditionalBasePermits": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "AdditionalBasePermits", "format": "int32", "nullable": true }, "AdditionalProductionQueueSlots": { "maximum": 20, "minimum": 0, "type": "integer", "description": "AdditionalProductionQueueSlots", "format": "int32", "nullable": true }, "HeadquartersNextRelocationTime": { "type": "string", "description": "HeadquartersNextRelocationTime", "format": "date-time", "nullable": true }, "HeadquartersRelocationLocked": { "type": "boolean", "description": "HeadquartersRelocationLocked", "nullable": true }, "HeadquartersAgricultureEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersAgricultureEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersChemistryEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersChemistryEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersConstructionEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersConstructionEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersElectronicsEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersElectronicsEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersFoodIndustriesEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersFoodIndustriesEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersFuelRefiningEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersFuelRefiningEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersManufacturingEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersManufacturingEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersMetallurgyEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersMetallurgyEfficiencyGain", "format": "double", "nullable": true }, "HeadquartersResourceExtractionEfficiencyGain": { "maximum": 100, "minimum": 0, "type": "number", "description": "HeadquartersResourceExtractionEfficiencyGain", "format": "double", "nullable": true }, "AICLiquid": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "AICLiquid", "format": "double", "nullable": true }, "CISLiquid": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "CISLiquid", "format": "double", "nullable": true }, "ECDLiquid": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "ECDLiquid", "format": "double", "nullable": true }, "ICALiquid": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "ICALiquid", "format": "double", "nullable": true }, "NCCLiquid": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "NCCLiquid", "format": "double", "nullable": true }, "RepresentationCurrentLevel": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "RepresentationCurrentLevel", "format": "int32", "nullable": true }, "RepresentationCostNextLevel": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "RepresentationCostNextLevel", "format": "double", "nullable": true }, "RepresentationContributedNextLevel": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "RepresentationContributedNextLevel", "format": "double", "nullable": true }, "RepresentationLeftNextLevel": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "RepresentationLeftNextLevel", "format": "double", "nullable": true }, "RepresentationContributedTotal": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "RepresentationContributedTotal", "format": "double", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "nullable": true, "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true } }, "additionalProperties": false, "description": "Company" }, "CompanyIndividualUserResponse": { "title": "IndividualUserResponse", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "$ref": "#/components/schemas/Company" } }, "additionalProperties": false, "description": "An individual response" }, "CompanyOffice": { "type": "object", "properties": { "CompanyOfficeId": { "maxLength": 65, "minLength": 35, "type": "string", "description": "CompanyOfficeId: {CompanyId}-{StartEpochMs}" }, "Type": { "maxLength": 32, "minLength": 8, "type": "string", "description": "Type" }, "Start": { "type": "string", "description": "Start", "format": "date-time" }, "End": { "type": "string", "description": "End", "format": "date-time" }, "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId" }, "PlanetName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PlanetName", "nullable": true }, "PlanetNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "PlanetNaturalId" } }, "additionalProperties": false, "description": "CompanyOffice" }, "CompanyPermissions": { "type": "object", "properties": { "Info": { "type": "boolean", "description": "Info", "default": true }, "LiquidCurrency": { "type": "boolean", "description": "LiquidCurrency", "default": true }, "Headquarters": { "type": "boolean", "description": "Headquarters", "default": true } }, "additionalProperties": false, "description": "Company permissions" }, "CompanyPlanet": { "type": "object", "properties": { "CompanyPlanetId": { "maxLength": 65, "minLength": 65, "type": "string", "description": "CompanyPlanetId: {CompanyId}-{PlanetId}" }, "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId" }, "PlanetName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PlanetName" }, "PlanetNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "PlanetNaturalId" } }, "additionalProperties": false, "description": "CompanyPlanet" }, "CompanyRetrievalResponse": { "title": "RetrievalResponse", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CompanyIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "Contract": { "type": "object", "properties": { "Id": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Id" }, "LocalId": { "maxLength": 32, "minLength": 1, "type": "string", "description": "LocalId" }, "Date": { "type": "string", "description": "Date", "format": "date-time" }, "Party": { "maxLength": 32, "minLength": 1, "type": "string", "description": "Party" }, "PartnerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PartnerId", "nullable": true }, "PartnerCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "PartnerCode", "nullable": true }, "PartnerName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PartnerName", "nullable": true }, "PartnerUserName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PartnerUserName - This requires that the user in question has been parsed by FIOAPI once (via USR buffer)", "nullable": true }, "Status": { "maxLength": 32, "minLength": 1, "type": "string", "description": "Status" }, "ExtensionDeadline": { "type": "string", "description": "ExtensionDeadline", "format": "date-time", "nullable": true }, "CanExtend": { "type": "boolean", "description": "CanExtend" }, "CanRequestTermination": { "type": "boolean", "description": "CanRequestTerminiation" }, "DueDate": { "type": "string", "description": "DueDate", "format": "date-time", "nullable": true }, "Name": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Name", "nullable": true }, "Preamble": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Preamble", "nullable": true }, "TerminationSent": { "type": "boolean", "description": "TerminationSent" }, "TerminationReceived": { "type": "boolean", "description": "TerminationReceived" }, "AgentContract": { "type": "boolean", "description": "AgentContract" }, "RelatedContractsList": { "type": "array", "items": { "type": "string" }, "description": "RelatedContractsList", "readOnly": true }, "ContractType": { "maxLength": 64, "minLength": 2, "type": "string", "description": "ContractType", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "Conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ContractCondition" }, "description": "Conditions" } }, "additionalProperties": false, "description": "Contract" }, "ContractCondition": { "type": "object", "properties": { "Id": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Id" }, "Type": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Type" }, "Index": { "type": "integer", "description": "Index", "format": "int32" }, "Status": { "maxLength": 32, "minLength": 2, "type": "string", "description": "Status" }, "DependenciesList": { "type": "array", "items": { "type": "string" }, "description": "DependenciesList", "readOnly": true }, "DeadlineDuration": { "type": "integer", "description": "DeadlineDuration", "format": "int64", "nullable": true }, "Deadline": { "type": "string", "description": "Deadline", "format": "date-time", "nullable": true }, "QuantityMaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "QuantityMaterialTicker", "nullable": true }, "QuantityAmount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "QuantityAmount", "format": "int32", "nullable": true }, "AddressId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "AddressId", "nullable": true }, "AddressNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "AddressNaturalId", "nullable": true }, "AddressName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "AddressName", "nullable": true }, "BlockId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "BlockId", "nullable": true }, "PickedUpMaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "PickedUpMaterialTicker", "nullable": true }, "PickedUpAmount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "PickedUpAmount", "format": "int32", "nullable": true }, "Weight": { "type": "number", "description": "Weight", "format": "double", "nullable": true }, "Volume": { "type": "number", "description": "Volume", "format": "double", "nullable": true }, "DestinationAddressId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "DestinationAddressId", "nullable": true }, "DestinationAddressNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "DestinationAddressNaturalId", "nullable": true }, "DestinationAddressName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "DestinationAddressName", "nullable": true }, "ShipmentItemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ShipmentItemId", "nullable": true }, "CountryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CountryId", "nullable": true }, "ReputationChange": { "type": "integer", "description": "ReputationChange", "format": "int32", "nullable": true }, "LoanInterestAmount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LoanInterestAmount", "format": "double", "nullable": true }, "LoanInterestCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "LoanInterestCurrency", "nullable": true }, "LoanRepaymentAmount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LoanRepaymentAmount", "format": "double", "nullable": true }, "LoanRepaymentCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "LoanRepaymentCurrency", "nullable": true }, "LoanTotalAmount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LoanTotalAmount", "format": "double", "nullable": true }, "LoanTotalCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "LoanTotalCurrency", "nullable": true } }, "additionalProperties": false, "description": "ContractCondition" }, "ContractListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "ContractListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContractListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "ContributionMaterialAndAmount": { "type": "object", "properties": { "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Ticker" }, "Amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Amount", "format": "int32" } }, "additionalProperties": false, "description": "ContributionMaterialAndAmount" }, "Country": { "type": "object", "properties": { "CountryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CountryId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name of the country" }, "Code": { "maxLength": 2, "minLength": 2, "type": "string", "description": "Country code" }, "NumericCode": { "maximum": 5, "minimum": 1, "type": "integer", "description": "Currency numeric code", "format": "int32" }, "CurrenyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Currency code" }, "CurrencyName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Name of the currency" }, "CurrencyDecimals": { "type": "integer", "description": "Decimals to show for this currency", "format": "int32" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "nullable": true, "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true } }, "additionalProperties": false, "description": "Country" }, "Create": { "type": "object", "properties": { "RequestedId": { "maximum": 999999, "minimum": 0, "type": "integer", "description": "An optionally requested Id number", "format": "int32" }, "GroupName": { "maxLength": 16, "minLength": 3, "type": "string", "description": "The name of the group" }, "Invites": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvite" }, "description": "All the invites" }, "Permissions": { "$ref": "#/components/schemas/Permissions" } }, "additionalProperties": false, "description": "The Create payload" }, "CreateAPIKey": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Your username", "example": "Saganaki" }, "Password": { "maxLength": 256, "minLength": 3, "type": "string", "description": "Your password", "example": "Hunter2" }, "ApplicationName": { "maxLength": 128, "minLength": 0, "type": "string", "description": "The application name for the APIkey", "example": "My Spreadsheet" }, "AllowWrites": { "type": "boolean", "description": "If this APIKey will allow writes", "default": false, "example": false } }, "additionalProperties": false, "description": "Structure for creating an APIKey" }, "CreateAccount": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "The UserName" }, "Password": { "maxLength": 256, "minLength": 3, "type": "string", "description": "The password" }, "Admin": { "type": "boolean", "description": "If the user should be admin", "default": false }, "Bot": { "type": "boolean", "description": "If the user should be a bot", "default": false } }, "additionalProperties": false, "description": "The payload for admin account creation" }, "CreateResponse": { "type": "object", "properties": { "GroupId": { "maximum": 999999, "minimum": 1, "type": "integer", "description": "The GroupId of the new group", "format": "int32" } }, "additionalProperties": false, "description": "Response to group create" }, "DATA_DATA_GATEWAYS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/DATA_DATA_GATEWAYS_PAYLOAD" } }, "additionalProperties": false }, "DATA_DATA_GATEWAYS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/DATA_DATA_GATEWAYS_PAYLOAD_INNER" } }, "additionalProperties": false }, "DATA_DATA_GATEWAYS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/DATA_DATA_GATEWAYS_MESSAGE" } }, "additionalProperties": false }, "DATA_DATA_GATEWAYS_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "type": "array", "items": { "$ref": "#/components/schemas/GATEWAY_BODY" } }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "DeleteAccount": { "type": "object", "properties": { "Password": { "maxLength": 256, "minLength": 3, "type": "string", "description": "Your password", "example": "Hunter2" } }, "additionalProperties": false, "description": "The DeleteAccount payload" }, "EfficiencyFactor": { "type": "object", "properties": { "ExpertiseCategory": { "type": "string", "description": "ExpertiseCategory", "nullable": true }, "Type": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Type" }, "Effectivity": { "maximum": 5, "minimum": 0, "type": "number", "description": "Effectivity", "format": "double" }, "Value": { "maximum": 5, "minimum": 0, "type": "number", "description": "Value", "format": "double" } }, "additionalProperties": false, "description": "EfficiencyFactor" }, "Expert": { "type": "object", "properties": { "SiteId": { "type": "string", "description": "SiteId", "readOnly": true }, "LocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocationId" }, "LocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "LocationName" }, "LocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "LocationNaturalId" }, "Total": { "maximum": 50, "minimum": 0, "type": "integer", "description": "Total", "format": "int32" }, "Active": { "maximum": 6, "minimum": 0, "type": "integer", "description": "Active", "format": "int32" }, "TotalActiveCap": { "maximum": 6, "minimum": 0, "type": "integer", "description": "TotalActiveCap", "format": "int32" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "ExpertEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ExpertEntry" }, "description": "ExpertEntries" } }, "additionalProperties": false, "description": "Expert" }, "ExpertEntry": { "type": "object", "properties": { "Category": { "maxLength": 19, "minLength": 9, "type": "string", "description": "Category" }, "Current": { "maximum": 5, "minimum": 0, "type": "integer", "description": "Current", "format": "int32" }, "Limit": { "maximum": 5, "minimum": 0, "type": "integer", "description": "Limit", "format": "int32" }, "Available": { "maximum": 5, "minimum": 0, "type": "integer", "description": "Available", "format": "int32" }, "EfficiencyGain": { "maximum": 50, "minimum": 0, "type": "number", "description": "EfficiencyGain", "format": "double" } }, "additionalProperties": false, "description": "ExpertEntry" }, "ExpertListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Expert" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "ExpertListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ExpertListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "FX": { "type": "object", "properties": { "FXID": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FXID" }, "Ticker": { "maxLength": 7, "minLength": 7, "type": "string", "description": "The ticker for an FX entry `XXX/YYY`" }, "BaseCurrencyNumericCode": { "type": "integer", "description": "BaseCurrencyNumericCode", "format": "int32" }, "BaseCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "BaseCurrencyCode" }, "BaseCurrencyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "BaseCurrencyName" }, "BaseCurrencyDecimals": { "maximum": 100, "minimum": 1, "type": "integer", "description": "BaseCurrencyDecimals", "format": "int32" }, "QuoteCurrencyNumericCode": { "type": "integer", "description": "QuoteCurrencyNumericCode", "format": "int32" }, "QuoteCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "QuoteCurrencyCode" }, "QuoteCurrencyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "QuoteCurrencyName" }, "QuoteCurrencyDecimals": { "maximum": 100, "minimum": 1, "type": "integer", "description": "QuoteCurrencyDecimals", "format": "int32" }, "Decimals": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Decimals", "format": "int32" }, "Open": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Open", "format": "double" }, "Close": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Close", "format": "double" }, "Low": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Low", "format": "double" }, "High": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "High", "format": "double" }, "Previous": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Previous", "format": "double" }, "Traded": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "traded", "format": "double" }, "Volume": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Volume", "format": "double" }, "Bid": { "maximum": 1.7976931348623157E+308, "minimum": 1E-05, "type": "number", "description": "BidRate", "format": "double", "nullable": true }, "Ask": { "maximum": 1.7976931348623157E+308, "minimum": 1E-05, "type": "number", "description": "AskRate", "format": "double", "nullable": true }, "Spread": { "maximum": 1.7976931348623157E+308, "minimum": 1E-05, "type": "number", "description": "Spread", "format": "double", "nullable": true }, "LotSizeAmount": { "maximum": 1.7976931348623157E+308, "minimum": 1E-05, "type": "number", "description": "LotSizeAmount", "format": "double" }, "LotCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "LotCurrency" }, "FeesFactor": { "maximum": 100, "minimum": 1E-05, "type": "number", "description": "FeesFactor", "format": "double" }, "BuyOrders": { "type": "array", "items": { "$ref": "#/components/schemas/FXBuyOrder" }, "description": "BuyOrders" }, "SellOrders": { "type": "array", "items": { "$ref": "#/components/schemas/FXSellOrder" }, "description": "SellOrders" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "FX" }, "FXBuyOrder": { "type": "object", "properties": { "FXBuyOrderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FXBuyOrderId" }, "UserId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "UserId" }, "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" }, "UserCompanyCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "UserCompanyCode" }, "Amount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Amount", "format": "double" }, "Rate": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Rate", "format": "double" } }, "additionalProperties": false, "description": "FXBuyOrder" }, "FXSellOrder": { "type": "object", "properties": { "FXSellOrderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FXSellOrderId" }, "UserId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "UserId" }, "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" }, "UserCompanyCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "UserCompanyCode" }, "Amount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Amount", "format": "double" }, "Rate": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Rate", "format": "double" } }, "additionalProperties": false, "description": "FXSellOrder" }, "FinishedRequestPayload": { "type": "object", "properties": { "InitialState": { "$ref": "#/components/schemas/InitialState" }, "LoggedRequests": { "type": "array", "items": { "$ref": "#/components/schemas/LoggedRequest" }, "description": "All the logged requests" } }, "additionalProperties": false, "description": "The response from a finished request" }, "Flight": { "type": "object", "properties": { "FlightId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FlightId" }, "ShipId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ShipId" }, "OriginId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "OriginId", "nullable": true }, "OriginName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "OriginName", "nullable": true }, "OriginNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "OriginNaturalId", "nullable": true }, "DestinationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "DestinationId", "nullable": true }, "DestinationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "DestinationName", "nullable": true }, "DestinationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "DestinationNaturalId", "nullable": true }, "Departure": { "type": "string", "description": "Departure", "format": "date-time" }, "Arrival": { "type": "string", "description": "Arrival", "format": "date-time" }, "CurrentSegmentIndex": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "CurrentSegmentIndex", "format": "int32" }, "STLDistance": { "type": "number", "description": "STLDistance", "format": "double" }, "FTLDistance": { "type": "number", "description": "FTLDistance", "format": "double" }, "Aborted": { "type": "boolean", "description": "Aborted" }, "FlightSegments": { "type": "array", "items": { "$ref": "#/components/schemas/FlightSegment" }, "description": "FlightSegments" }, "Timestamp": { "type": "string", "description": "The timestamp of the data", "format": "date-time" } }, "additionalProperties": false, "description": "Flight" }, "FlightSegment": { "type": "object", "properties": { "SegmentIndex": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "SegmentIndex", "format": "int32" }, "Type": { "maxLength": 32, "minLength": 0, "type": "string", "description": "Type" }, "OriginId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Origin", "nullable": true }, "OriginNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "OriginNaturalId", "nullable": true }, "OriginName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "OriginName", "nullable": true }, "OriginSemiMajorAxis": { "type": "number", "description": "OriginSemiMajorAxis", "format": "double", "nullable": true }, "OriginEccentricity": { "type": "number", "description": "OriginEccentricity", "format": "double", "nullable": true }, "OriginInclination": { "type": "number", "description": "OriginInclination", "format": "double", "nullable": true }, "OriginRightAscension": { "type": "number", "description": "OriginRightAscension", "format": "double", "nullable": true }, "OriginPeriapsis": { "type": "number", "description": "OriginPeriapsis", "format": "double", "nullable": true }, "Departure": { "type": "string", "description": "Departure", "format": "date-time" }, "Arrival": { "type": "string", "description": "Arrival", "format": "date-time" }, "DestinationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "DestinationId", "nullable": true }, "DestinationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "DestinationNaturalId", "nullable": true }, "DestinationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "DestinationName", "nullable": true }, "DestinationSemiMajorAxis": { "type": "number", "description": "DestinationSemiMajorAxis", "format": "double", "nullable": true }, "DestinationEccentricity": { "type": "number", "description": "DestinationEccentricity", "format": "double", "nullable": true }, "DestinationInclination": { "type": "number", "description": "DestinationInclination", "format": "double", "nullable": true }, "DestinationRightAscension": { "type": "number", "description": "DestinationRightAscension", "format": "double", "nullable": true }, "DestinationPeriapsis": { "type": "number", "description": "DestinationPeriapsis", "format": "double", "nullable": true }, "TransferEllipseStartPositionX": { "type": "number", "description": "TransferEllipseStartPositionX", "format": "double", "nullable": true }, "TransferEllipseStartPositionY": { "type": "number", "description": "TransferEllipseStartPositionY", "format": "double", "nullable": true }, "TransferEllipseStartPositionZ": { "type": "number", "description": "TransferEllipseStartPositionZ", "format": "double", "nullable": true }, "TransferEllipseTargetPositionX": { "type": "number", "description": "TransferEllipseTargetPositionX", "format": "double", "nullable": true }, "TransferEllipseTargetPositionY": { "type": "number", "description": "TransferEllipseTargetPositionY", "format": "double", "nullable": true }, "TransferEllipseTargetPositionZ": { "type": "number", "description": "TransferEllipseTargetPositionZ", "format": "double", "nullable": true }, "TransferEllipseCenterPositionX": { "type": "number", "description": "TransferEllipseCenterPositionX", "format": "double", "nullable": true }, "TransferEllipseCenterPositionY": { "type": "number", "description": "TransferEllipseCenterPositionY", "format": "double", "nullable": true }, "TransferEllipseCenterPositionZ": { "type": "number", "description": "TransferEllipseCenterPositionZ", "format": "double", "nullable": true }, "TransferEllipseAlpha": { "type": "number", "description": "TransferEllipseAlpha", "format": "double", "nullable": true }, "TransferEllipseSemiMajorAxis": { "type": "number", "description": "TransferEllipseSemiMajorAxis", "format": "double", "nullable": true }, "TransferEllipseSemiMinorAxis": { "type": "number", "description": "TransferEllipseSemiMinorAxis", "format": "double", "nullable": true }, "STLDistance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "STLDistance", "format": "double", "nullable": true }, "FTLDistance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "FTLDistance", "format": "double", "nullable": true }, "STLFuelConsumption": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "STLFuelConsumption", "format": "double", "nullable": true }, "FTLFuelConsumption": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "FTLFuelConsumption", "format": "double", "nullable": true }, "Damage": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Damage", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "FlightSegment" }, "GATEWAY_BODY": { "type": "object", "properties": { "type": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "name": { "maxLength": 64, "minLength": 0, "type": "string" }, "naturalId": { "type": "string" }, "owner": { "$ref": "#/components/schemas/GATEWAY_OWNER" }, "operationalState": { "maxLength": 32, "minLength": 0, "type": "string" }, "established": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "jumpsPerDay": { "type": "integer", "format": "int32" }, "maxShipVolume": { "type": "number", "format": "double" }, "linkingRadius": { "type": "number", "format": "double" }, "capacityUpgrades": { "type": "integer", "format": "int32" }, "volumeUpgrades": { "type": "integer", "format": "int32" }, "distanceUpgrades": { "type": "integer", "format": "int32" }, "outgoingLink": { "type": "string", "nullable": true }, "incomingLinks": { "type": "array", "items": { "type": "string" } }, "linkStatus": { "maxLength": 32, "minLength": 0, "type": "string" }, "linkEstablished": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "upkeep": { "$ref": "#/components/schemas/GATEWAY_UPKEEP" }, "upgrade": { "$ref": "#/components/schemas/GATEWAY_UPGRADE" }, "fuel": { "$ref": "#/components/schemas/GATEWAY_FUEL" }, "traffic": { "$ref": "#/components/schemas/GATEWAY_TRAFFIC" }, "id": { "type": "string" } }, "additionalProperties": false }, "GATEWAY_FUEL": { "type": "object", "properties": { "fuelContractors": { "type": "array", "items": { "$ref": "#/components/schemas/GATEWAY_UPKEEP_CONTRACTORS" } }, "fuelPerJump": { "type": "integer", "format": "int32" }, "availableFuelUnits": { "type": "integer", "format": "int32" }, "maxFuelUnits": { "type": "integer", "format": "int32" }, "averageFuelAvailability": { "type": "number", "format": "double" }, "usageFee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" } }, "additionalProperties": false }, "GATEWAY_OWNER": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "GATEWAY_PHASE": { "type": "object", "properties": { "start": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "end": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "phaseNaturalId": { "type": "integer", "format": "int32" }, "jumps": { "type": "number", "format": "double" }, "jumpsFailedDueInoperative": { "type": "number", "format": "double" }, "jumpsFailedDueInsufficientFuel": { "type": "number", "format": "double" }, "jumpsFailedDueNoCapacity": { "type": "number", "format": "double" }, "inboundJumps": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GATEWAY_TRAFFIC": { "type": "object", "properties": { "jumps": { "type": "integer", "format": "int32" }, "totalJumps": { "type": "integer", "format": "int32" }, "currentPhase": { "$ref": "#/components/schemas/GATEWAY_PHASE" }, "lastPhase": { "$ref": "#/components/schemas/GATEWAY_PHASE" }, "averages": { "$ref": "#/components/schemas/GATEWAY_PHASE" } }, "additionalProperties": false }, "GATEWAY_UPGRADE": { "type": "object", "properties": { "upgradeId": { "type": "string" }, "constructor": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "status": { "type": "string" }, "progress": { "type": "number", "format": "double" }, "done": { "nullable": true }, "failed": { "nullable": true }, "infrastructureType": { "type": "string" }, "currentParameters": { "$ref": "#/components/schemas/GATEWAY_UPGRADE_PARAMETERS" }, "targetParameters": { "$ref": "#/components/schemas/GATEWAY_UPGRADE_PARAMETERS" } }, "additionalProperties": false }, "GATEWAY_UPGRADE_PARAMETERS": { "type": "object", "properties": { "capacity": { "type": "number", "format": "double" }, "volume": { "type": "number", "format": "double" }, "distance": { "type": "number", "format": "double" }, "type": { "type": "string" } }, "additionalProperties": false }, "GATEWAY_UPKEEP": { "type": "object", "properties": { "upkeep": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "upkeepPhases": { "type": "array", "items": { "$ref": "#/components/schemas/GATEWAY_UPKEEP_PHASES" } }, "upkeepContractors": { "type": "array", "items": { "$ref": "#/components/schemas/GATEWAY_UPKEEP_CONTRACTORS" } }, "averageUptime": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GATEWAY_UPKEEP_CONTRACTOR": { "type": "object", "properties": { "contractor": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "contractId": { "type": "string" } }, "additionalProperties": false }, "GATEWAY_UPKEEP_CONTRACTORS": { "type": "object", "properties": { "phase": { "type": "integer", "format": "int32" }, "contractors": { "type": "array", "items": { "$ref": "#/components/schemas/GATEWAY_UPKEEP_CONTRACTOR" } } }, "additionalProperties": false }, "GATEWAY_UPKEEP_PHASES": { "type": "object", "properties": { "id": { "type": "string" }, "naturalId": { "type": "integer", "format": "int32" }, "start": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "end": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "serviceLevel": { "type": "number", "format": "double" }, "upkeep": { "type": "array", "items": { "$ref": "#/components/schemas/GATEWAY_UPKEEP_PHASES_UPKEEP" } } }, "additionalProperties": false }, "GATEWAY_UPKEEP_PHASES_UPKEEP": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "current": { "type": "integer", "format": "int32" }, "required": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Gateway": { "type": "object", "properties": { "GatewayId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "GatewayId" }, "Name": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Name" }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "LocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "LocationNaturalId" }, "Established": { "type": "string", "description": "Established", "format": "date-time", "nullable": true, "readOnly": true }, "CurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "CurrencyCode" }, "OperationalState": { "maxLength": 32, "minLength": 0, "type": "string", "description": "OperationalState" }, "JumpsPerDay": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "JumpsPerDay", "format": "int32" }, "MaxShipVolume": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "MaxShipVolume", "format": "double" }, "LinkingRadius": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LinkingRadius", "format": "double" }, "CapacityUpgrades": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "CapacityUpgrades", "format": "int32" }, "VolumeUpgrades": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "VolumeUpgrades", "format": "int32" }, "DistanceUpgrades": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "DistanceUpgrades", "format": "int32" }, "OutgoingLink": { "maxLength": 32, "minLength": 32, "type": "string", "description": "OutgoingLink", "nullable": true }, "IncomingLinks": { "type": "array", "items": { "type": "string" }, "description": "IncomingLinks", "readOnly": true }, "LinkStatus": { "maxLength": 32, "minLength": 0, "type": "string", "description": "LinkStatus" }, "LinkEstablished": { "type": "string", "description": "LinkEstablished", "format": "date-time", "nullable": true, "readOnly": true }, "UpgradeId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "UpgradeId", "nullable": true }, "UpgradeCreated": { "type": "string", "description": "UpgradeCreated", "format": "date-time", "nullable": true, "readOnly": true }, "UpgradeStatus": { "maxLength": 32, "minLength": 0, "type": "string", "description": "UpgradeStatus", "nullable": true }, "UpgradeCurrentCapacity": { "type": "number", "description": "UpgradeCurrentCapacity", "format": "double", "nullable": true }, "UpgradeCurrentVolume": { "type": "number", "description": "UpgradeCurrentVolume", "format": "double", "nullable": true }, "UpgradeCurrentDistance": { "type": "number", "description": "UpgradeCurrentDistance", "format": "double", "nullable": true }, "UpgradeTargetCapacity": { "type": "number", "description": "UpgradeTargetCapacity", "format": "double", "nullable": true }, "UpgradeTargetVolume": { "type": "number", "description": "UpgradeTargetVolume", "format": "double", "nullable": true }, "UpgradeTargetDistance": { "type": "number", "description": "UpgradeTargetDistance", "format": "double", "nullable": true }, "UpgraderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "UpgraderId", "nullable": true }, "UpgraderName": { "maxLength": 64, "minLength": 0, "type": "string", "description": "UpgraderName", "nullable": true }, "UpgraderCode": { "maxLength": 4, "minLength": 0, "type": "string", "description": "UpgraderCode", "nullable": true }, "FuelPerJump": { "type": "integer", "description": "FuelPerJump", "format": "int32", "nullable": true }, "AvailableFuelUnits": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "AvailableFuelUnits", "format": "int32", "nullable": true }, "MaxFuelUnits": { "type": "integer", "description": "MaxFuelUnits", "format": "int32", "nullable": true }, "AverageFuelAvailibility": { "maximum": 1, "minimum": 0, "type": "number", "description": "AverageFuelAvailibility", "format": "double", "nullable": true }, "UsageAmount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "UsageAmount", "format": "double", "nullable": true }, "UsageCurrency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "UsageCurrency", "nullable": true }, "Jumps": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Jumps", "format": "int32" }, "TotalJumps": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "TotalJumps", "format": "int32" }, "CurrentPhaseStart": { "type": "string", "description": "CurrentPhaseStart", "format": "date-time", "nullable": true, "readOnly": true }, "CurrentPhaseEnd": { "type": "string", "description": "CurrentPhaseStart", "format": "date-time", "nullable": true, "readOnly": true }, "CurrentPhaseNaturalId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "CurrentPhaseNaturalId", "format": "int32", "nullable": true }, "CurrentPhaseJumps": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "CurrentPhaseJumps", "format": "double", "nullable": true }, "CurrentPhaseJumpsFailedDueInoperative": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "CurrentPhaseJumpsFailedDueInoperative", "format": "double", "nullable": true }, "CurrentPhaseJumpsFailedDueInsufficientFuel": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "CurrentPhaseJumpsFailedDueInsufficientFuel", "format": "double", "nullable": true }, "CurrentPhaseJumpsFailedDueNoCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "CurrentPhaseJumpsFailedDueNoCapacity", "format": "double", "nullable": true }, "CurrentPhaseInboundJumps": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "CurrentPhaseInboundJumps", "format": "double", "nullable": true }, "LastPhaseStart": { "type": "string", "description": "LastPhaseStart", "format": "date-time", "nullable": true, "readOnly": true }, "LastPhaseEnd": { "type": "string", "description": "LastPhaseStart", "format": "date-time", "nullable": true, "readOnly": true }, "LastPhaseNaturalId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "LastPhaseNaturalId", "format": "int32", "nullable": true }, "LastPhaseJumps": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LastPhaseJumps", "format": "double", "nullable": true }, "LastPhaseJumpsFailedDueInoperative": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LastPhaseJumpsFailedDueInoperative", "format": "double", "nullable": true }, "LastPhaseJumpsFailedDueInsufficientFuel": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LastPhaseJumpsFailedDueInsufficientFuel", "format": "double", "nullable": true }, "LastPhaseJumpsFailedDueNoCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LastPhaseJumpsFailedDueNoCapacity", "format": "double", "nullable": true }, "LastPhaseInboundJumps": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LastPhaseInboundJumps", "format": "double", "nullable": true }, "PhaseAverageStart": { "type": "string", "description": "PhaseAverageStart", "format": "date-time", "nullable": true, "readOnly": true }, "PhaseAverageEnd": { "type": "string", "description": "PhaseAverageStart", "format": "date-time", "nullable": true, "readOnly": true }, "PhaseAverageNaturalId": { "maximum": 2147483647, "minimum": -1, "type": "integer", "description": "PhaseAverageNaturalId", "format": "int32", "nullable": true }, "PhaseAverageJumps": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "PhaseAverageJumps", "format": "double", "nullable": true }, "PhaseAverageJumpsFailedDueInoperative": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "PhaseAverageJumpsFailedDueInoperative", "format": "double", "nullable": true }, "PhaseAverageJumpsFailedDueInsufficientFuel": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "PhaseAverageJumpsFailedDueInsufficientFuel", "format": "double", "nullable": true }, "PhaseAverageJumpsFailedDueNoCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "PhaseAverageJumpsFailedDueNoCapacity", "format": "double", "nullable": true }, "PhaseAverageInboundJumps": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "PhaseAverageInboundJumps", "format": "double", "nullable": true }, "Upkeeps": { "type": "array", "items": { "$ref": "#/components/schemas/GatewayUpkeep" }, "description": "Upkeeps" }, "UpkeepPhases": { "type": "array", "items": { "$ref": "#/components/schemas/GatewayUpkeepPhase" }, "description": "UpkeepPhases" }, "UpkeepContractors": { "type": "array", "items": { "$ref": "#/components/schemas/GatewayUpkeepContractor" }, "description": "UpkeepContractors" }, "AverageUpkeepUptime": { "type": "number", "description": "AverageUpkeepUptime", "format": "double" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "Gateway" }, "GatewayUpkeep": { "type": "object", "properties": { "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialId" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "Amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Amount", "format": "int32" } }, "additionalProperties": false, "description": "GatewayUpkeep" }, "GatewayUpkeepContractor": { "type": "object", "properties": { "Phase": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Phase", "format": "int32" }, "ContractId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ContractId" }, "ContractorId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ContractorId" }, "ContractorName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "ContractorName" }, "ContractorCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "ContractorCode", "nullable": true } }, "additionalProperties": false, "description": "GatewayUpkeepContractor" }, "GatewayUpkeepPhase": { "type": "object", "properties": { "GatewayUpkeepPhaseId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "GatewayUpkeepPhaseId" }, "NaturalId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "NaturalId", "format": "int32" }, "Start": { "type": "string", "description": "Start", "format": "date-time", "readOnly": true }, "End": { "type": "string", "description": "End", "format": "date-time", "readOnly": true }, "ServiceLevel": { "type": "number", "description": "ServiceLevel", "format": "double" }, "Upkeeps": { "type": "array", "items": { "$ref": "#/components/schemas/PhaseUpkeep" }, "description": "Upkeeps", "readOnly": true } }, "additionalProperties": false, "description": "GatewayUpkeepPhase" }, "Grant": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 1, "type": "string", "description": "The username (or * for all users) to grant permission to" }, "Permissions": { "$ref": "#/components/schemas/Permissions" } }, "additionalProperties": false, "description": "The payload for Granting permissions" }, "GroupAdmin": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" } }, "additionalProperties": false, "description": "GroupAdmin model" }, "GroupDetailResponse": { "type": "object", "properties": { "GroupId": { "maximum": 999999, "minimum": 1, "type": "integer", "description": "GroupId", "format": "int32" }, "GroupName": { "maxLength": 16, "minLength": 3, "type": "string", "description": "GroupName" }, "GroupOwner": { "maxLength": 32, "minLength": 2, "type": "string", "description": "GroupOwner" }, "PendingInvites": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPendingInvite" }, "description": "PendingInvites" }, "Admins": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAdmin" }, "description": "Admins" }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/GroupUser" }, "description": "Users" }, "MemberUserNames": { "type": "array", "items": { "type": "string" }, "description": "Retrieves a list of member UserNames", "readOnly": true }, "Permissions": { "$ref": "#/components/schemas/Permissions" } }, "additionalProperties": false, "description": "GroupDetail response" }, "GroupPendingInvite": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" }, "Admin": { "type": "boolean", "description": "If the invite is for an admin role" } }, "additionalProperties": false, "description": "GroupPendingInvite model" }, "GroupUser": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" } }, "additionalProperties": false, "description": "GroupUser model" }, "InfrastructureProject": { "type": "object", "properties": { "InfrastructureProjectId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "InfrastructureProjectId" }, "Type": { "maxLength": 64, "minLength": 3, "type": "string", "description": "Type" }, "ProjectIdentifier": { "maxLength": 64, "minLength": 3, "type": "string", "description": "ProjectIdentifier" }, "Level": { "maximum": 2147483647, "minimum": -1, "type": "integer", "description": "Level", "format": "int32" }, "ActiveLevel": { "maximum": 2147483647, "minimum": -1, "type": "integer", "description": "ActiveLevel", "format": "int32" }, "CurrentLevel": { "maximum": 2147483647, "minimum": -1, "type": "integer", "description": "CurrentLevel", "format": "int32" }, "UpgradeStatus": { "maximum": 1, "minimum": 0, "type": "number", "description": "UpgradeStatus", "format": "double" }, "UpgradeCosts": { "type": "array", "items": { "$ref": "#/components/schemas/InfrastructureUpgradeCost" }, "description": "UpgradeCosts", "readOnly": true }, "PopulationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PopulationId" }, "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId", "nullable": true }, "PlanetName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PlanetName", "nullable": true }, "PlanetNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "PlanetNaturalId", "nullable": true }, "Contributions": { "type": "array", "items": { "$ref": "#/components/schemas/InfrastructureProjectContribution" }, "description": "Contributions" }, "Upkeeps": { "type": "array", "items": { "$ref": "#/components/schemas/InfrastructureProjectUpkeep" }, "description": "Upkeeps" } }, "additionalProperties": false, "description": "InfrastructureProject" }, "InfrastructureProjectContribution": { "type": "object", "properties": { "Materials": { "type": "array", "items": { "$ref": "#/components/schemas/ContributionMaterialAndAmount" }, "description": "Materials", "readOnly": true }, "Time": { "type": "string", "description": "Time", "format": "date-time", "readOnly": true }, "ContributerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ContributerId", "nullable": true }, "ContributerName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "ContributerName", "nullable": true }, "ContributerCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "ContributerCode", "nullable": true } }, "additionalProperties": false, "description": "InfrastructureProjectContribution" }, "InfrastructureProjectUpkeep": { "type": "object", "properties": { "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Ticker" }, "Amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Amount", "format": "int32" }, "CurrentAmount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Current Amount", "format": "int32" }, "Stored": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Stored", "format": "double" }, "StoreCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "StoreCapacity", "format": "double" }, "Duration": { "type": "integer", "description": "Duration", "format": "int64" }, "NextTick": { "type": "string", "description": "NextTick", "format": "date-time", "readOnly": true } }, "additionalProperties": false, "description": "InfrastructureProjectUpkeep" }, "InfrastructureUpgradeCost": { "type": "object", "properties": { "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Ticker" }, "Amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Amount", "format": "int32" }, "CurrentAmount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "CurrentAmount", "format": "int32" } }, "additionalProperties": false, "description": "InfrastructureUpgradeCost" }, "InitialState": { "type": "object", "properties": { "User": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false, "description": "The initial state of the request logger" }, "Invite": { "type": "object", "properties": { "GroupId": { "maximum": 999999, "minimum": 1, "type": "integer", "description": "GroupId", "format": "int32" }, "Invites": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvite" }, "description": "Invites" } }, "additionalProperties": false, "description": "Invite payload" }, "InviteResponse": { "type": "object", "properties": { "GroupId": { "maximum": 999999, "minimum": 1, "type": "integer", "description": "GroupId", "format": "int32" }, "GroupName": { "maxLength": 16, "minLength": 3, "type": "string", "description": "The group name" }, "Admin": { "type": "boolean", "description": "If this is an invite for an admin role" }, "Permisssions": { "$ref": "#/components/schemas/Permissions" } }, "additionalProperties": false, "description": "Invite response" }, "JumpCacheRouteJump": { "type": "object", "properties": { "SourceSystemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SourceSystemId" }, "SourceSystemName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "SourceSystemName", "nullable": true }, "SourceSystemNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "SourceSystemNaturalId" }, "DestinationSystemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "DestinationSystemId" }, "DestinationSystemName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "DestinationSystemName", "nullable": true }, "DestinationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "DestinationNaturalId" }, "Distance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Distance", "format": "double" } }, "additionalProperties": false, "description": "JumpCacheRouteJump" }, "LocalMarketAd": { "type": "object", "properties": { "LocalMarketAdId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocalMarketAdId" }, "LocalMarketId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocalMarketId" }, "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId" }, "PlanetNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "PlanetName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "PlanetName" }, "AdNaturalId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "AdNaturalId", "format": "int32" }, "Type": { "maxLength": 18, "minLength": 16, "type": "string", "description": "Type" }, "Weight": { "maximum": 100000, "minimum": 1E-05, "type": "number", "description": "Weight", "format": "double", "nullable": true }, "Volume": { "maximum": 100000, "minimum": 1E-05, "type": "number", "description": "Volume", "format": "double", "nullable": true }, "CreatorId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CreatorId" }, "CreatorName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "CreatorName" }, "CreatorCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CreatorCode" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker", "nullable": true }, "MaterialAmount": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "MaterialAmount", "format": "int32", "nullable": true }, "Price": { "maximum": 1.7976931348623157E+308, "minimum": 1E-06, "type": "number", "description": "Price", "format": "double" }, "Currency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Currency" }, "FulfillmentDays": { "maximum": 100, "minimum": 1, "type": "integer", "description": "FulfillmentDays", "format": "int32" }, "MinimumRating": { "maxLength": 7, "minLength": 1, "type": "string", "description": "MinimumRating" }, "CreationTime": { "type": "string", "description": "CreationTime", "format": "date-time" }, "Expiry": { "type": "string", "description": "Expiry", "format": "date-time" }, "OriginNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "OriginNaturalId", "nullable": true }, "DestinationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "DestinationNaturalId", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "LocalMarketAd" }, "LoggedRequest": { "type": "object", "properties": { "Method": { "type": "string", "description": "Method (GET, PUT, POST, DELETE)" }, "Path": { "type": "string", "description": "The path of the endpoint, including query params" }, "ContentType": { "type": "string", "description": "ContentType", "nullable": true }, "Content": { "type": "string", "description": "Content", "nullable": true } }, "additionalProperties": false, "description": "The logged request" }, "Login": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Your username", "example": "Saganaki" }, "Password": { "maxLength": 256, "minLength": 3, "type": "string", "description": "Your password", "example": "Hunter2" } }, "additionalProperties": false, "description": "The login payload" }, "LoginResponse": { "type": "object", "properties": { "Token": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "The Jwt Bearer token", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "IsAdministrator": { "type": "boolean", "description": "If users is admin" } }, "additionalProperties": false, "description": "The response from a login request" }, "MAP_SYSTEM": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MAP_SYSTEM_PAYLOAD" } }, "additionalProperties": false }, "MAP_SYSTEM_BODY": { "type": "object", "properties": { "naturalId": { "type": "string" }, "name": { "type": "string" }, "namer": { "$ref": "#/components/schemas/APEX_COMMON_USER" }, "namingDate": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "nameable": { "type": "boolean" }, "star": { "$ref": "#/components/schemas/MAP_SYSTEM_STAR" }, "meteoroidDensity": { "type": "number", "format": "double" }, "planets": { "type": "array", "items": { "$ref": "#/components/schemas/MAP_SYSTEM_PLANET" } }, "celestialBodies": { "type": "array", "items": { "$ref": "#/components/schemas/MAP_SYSTEM_CELESTIAL_BODY" } }, "connections": { "type": "array", "items": { "type": "string" } }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "country": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "id": { "type": "string" } }, "additionalProperties": false }, "MAP_SYSTEM_CELESTIAL_BODY": { "type": "object", "properties": { "id": { "type": "string" }, "naturalId": { "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "orbit": { "$ref": "#/components/schemas/MAP_SYSTEM_ORBIT" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" } }, "additionalProperties": false }, "MAP_SYSTEM_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MAP_SYSTEM_PAYLOAD_INNER" } }, "additionalProperties": false }, "MAP_SYSTEM_ORBIT": { "type": "object", "properties": { "semiMajorAxis": { "type": "number", "format": "double" }, "eccentricity": { "type": "number", "format": "double" }, "inclination": { "type": "number", "format": "double" }, "rightAscension": { "type": "number", "format": "double" }, "periapsis": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MAP_SYSTEM_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MAP_SYSTEM_MESSAGE" } }, "additionalProperties": false }, "MAP_SYSTEM_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/MAP_SYSTEM_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "MAP_SYSTEM_PLANET": { "type": "object", "properties": { "id": { "type": "string" }, "naturalId": { "type": "string" }, "orbit": { "$ref": "#/components/schemas/MAP_SYSTEM_ORBIT" }, "mass": { "type": "number", "format": "double" }, "massEarth": { "type": "number", "format": "double" }, "surface": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" } }, "additionalProperties": false }, "MAP_SYSTEM_STAR": { "type": "object", "properties": { "type": { "maxLength": 1, "minLength": 1, "type": "string" }, "luminosity": { "type": "number", "format": "double" }, "position": { "$ref": "#/components/schemas/MAP_SYSTEM_STAR_POSITION" }, "sectorId": { "maxLength": 10, "minLength": 8, "type": "string" }, "subSectorId": { "maxLength": 20, "minLength": 13, "type": "string" }, "mass": { "type": "number", "format": "double" }, "massSol": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MAP_SYSTEM_STAR_POSITION": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MAP_WORLD_SECTORS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_PAYLOAD" } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_HEX": { "type": "object", "properties": { "q": { "type": "integer", "format": "int32" }, "r": { "type": "integer", "format": "int32" }, "s": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_PAYLOAD_INNER" } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_MESSAGE" } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_PAYLOAD_INNER": { "type": "object", "properties": { "sectors": { "type": "array", "items": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_SECTOR" } } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_SECTOR": { "type": "object", "properties": { "id": { "maxLength": 10, "minLength": 8, "type": "string" }, "name": { "type": "string", "nullable": true }, "hex": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_HEX" }, "size": { "type": "integer", "format": "int32" }, "subsectors": { "type": "array", "items": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_SUBSECTOR" } } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_SUBSECTOR": { "type": "object", "properties": { "id": { "maxLength": 20, "minLength": 13, "type": "string" }, "vertices": { "type": "array", "items": { "$ref": "#/components/schemas/MAP_WORLD_SECTORS_VERTEX" } } }, "additionalProperties": false }, "MAP_WORLD_SECTORS_VERTEX": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_ACCOUNTING_CASH_BALANCES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES_PAYLOAD" } }, "additionalProperties": false }, "MESG_ACCOUNTING_CASH_BALANCES_CURRENCY_ACCOUNT": { "type": "object", "properties": { "category": { "type": "string" }, "type": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "number": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "bookBalance": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "currencyBalance": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" } }, "additionalProperties": false }, "MESG_ACCOUNTING_CASH_BALANCES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_ACCOUNTING_CASH_BALANCES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES_MESSAGE" } }, "additionalProperties": false }, "MESG_ACCOUNTING_CASH_BALANCES_PAYLOAD_INNER": { "type": "object", "properties": { "ownCurrency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "currencyAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_ACCOUNTING_CASH_BALANCES_CURRENCY_ACCOUNT" } } }, "additionalProperties": false }, "MESG_CHANNEL_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_CHANNEL_DATA_PAYLOAD" } }, "additionalProperties": false }, "MESG_CHANNEL_DATA_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SHARED_CHANNEL_DATA_PAYLOAD" } }, "additionalProperties": false }, "MESG_CHANNEL_DATA_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_CHANNEL_DATA_MESSAGE" } }, "additionalProperties": false }, "MESG_CHANNEL_MESSAGE_ADDED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_CHANNEL_MESSAGE_ADDED_PAYLOAD" } }, "additionalProperties": false }, "MESG_CHANNEL_MESSAGE_ADDED_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SHARED_MESSAGE_ADDED" } }, "additionalProperties": false }, "MESG_CHANNEL_MESSAGE_ADDED_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_CHANNEL_MESSAGE_ADDED_MESSAGE" } }, "additionalProperties": false }, "MESG_COMEX_BROKER_PRICES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES_PAYLOAD" } }, "additionalProperties": false }, "MESG_COMEX_BROKER_PRICES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_COMEX_BROKER_PRICES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES_MESSAGE" } }, "additionalProperties": false }, "MESG_COMEX_BROKER_PRICES_PAYLOAD_INNER": { "type": "object", "properties": { "brokerId": { "type": "string" }, "from": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES_PRICE" } } }, "additionalProperties": false }, "MESG_COMEX_BROKER_PRICES_PRICE": { "type": "object", "properties": { "interval": { "type": "string" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMEX_BROKER_PRICES_PRICE_DATA" } } }, "additionalProperties": false }, "MESG_COMEX_BROKER_PRICES_PRICE_DATA": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "open": { "type": "number", "format": "double" }, "close": { "type": "number", "format": "double" }, "high": { "type": "number", "format": "double" }, "low": { "type": "number", "format": "double" }, "volume": { "type": "number", "format": "double" }, "traded": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_COMEX_TRADER_ORDER": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER_PAYLOAD" } }, "additionalProperties": false }, "MESG_COMEX_TRADER_ORDER_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_COMEX_TRADER_ORDER_ORDER": { "type": "object", "properties": { "id": { "type": "string" }, "exchange": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "brokerId": { "type": "string" }, "type": { "maxLength": 7, "minLength": 6, "type": "string" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "initialAmount": { "type": "integer", "format": "int32" }, "limit": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "status": { "type": "string" }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "trades": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER_TRADE" } } }, "additionalProperties": false }, "MESG_COMEX_TRADER_ORDER_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER_MESSAGE" } }, "additionalProperties": false }, "MESG_COMEX_TRADER_ORDER_PAYLOAD_INNER": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMEX_TRADER_ORDER_ORDER" } } }, "additionalProperties": false }, "MESG_COMEX_TRADER_ORDER_TRADE": { "type": "object", "properties": { "id": { "type": "string" }, "amount": { "type": "integer", "format": "int32" }, "price": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "partner": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" } }, "additionalProperties": false }, "MESG_COMPANY_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_PAYLOAD" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_CURRENCY_ACCOUNT": { "type": "object", "properties": { "category": { "type": "string" }, "type": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "number": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "bookBalance": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "currencyBalance": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_HQ": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "level": { "type": "integer", "format": "int32" }, "basePermits": { "type": "integer", "format": "int32" }, "usedBasePermits": { "type": "integer", "format": "int32" }, "inventory": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_HQ_INVENTORY" }, "additionalBasePermits": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "additionalProductionQueueSlots": { "maximum": 20, "minimum": 0, "type": "integer", "format": "int32" }, "nextRelocationTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "relocationLocked": { "type": "boolean" }, "efficiencyGains": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_HQ_EFFICIENCY_GAIN" } }, "efficiencyGainsNextLevel": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_HQ_EFFICIENCY_GAIN" } } }, "additionalProperties": false }, "MESG_COMPANY_DATA_HQ_EFFICIENCY_GAIN": { "type": "object", "properties": { "category": { "type": "string" }, "gain": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_HQ_INVENTORY": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_HQ_INVENTORY_ITEM" } } }, "additionalProperties": false }, "MESG_COMPANY_DATA_HQ_INVENTORY_ITEM": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "limit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_MESSAGE" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_PAYLOAD_INNER": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "code": { "maxLength": 4, "minLength": 1, "type": "string" }, "countryId": { "type": "string" }, "startingProfile": { "maxLength": 20, "minLength": 1, "type": "string" }, "startingLocation": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "ratingReport": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_RATING_REPORT" }, "headquarters": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_HQ" } }, "additionalProperties": false }, "MESG_COMPANY_DATA_RATING_REPORT": { "type": "object", "properties": { "overallRating": { "maxLength": 7, "minLength": 1, "type": "string" }, "subRatings": { "nullable": true } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACT": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT_PAYLOAD" } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_PAYLOAD" } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS_CONDITION": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "type": { "type": "string" }, "id": { "type": "string" }, "party": { "type": "string" }, "index": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "deadlineDuration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "deadline": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "quantity": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "blockId": { "type": "string", "nullable": true }, "pickedUp": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" }, "weight": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "format": "double", "nullable": true }, "destination": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "shipmentItemId": { "type": "string", "nullable": true }, "countryId": { "type": "string", "nullable": true }, "reputationChange": { "type": "integer", "format": "int32", "nullable": true }, "interest": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "repayment": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "total": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS_CONTRACT": { "type": "object", "properties": { "id": { "type": "string" }, "localId": { "maxLength": 8, "minLength": 1, "type": "string" }, "date": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "party": { "type": "string" }, "partner": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_PARTNER" }, "status": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_CONDITION" } }, "extensionDeadline": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "canExtend": { "type": "boolean" }, "canRequestTermination": { "type": "boolean" }, "dueDate": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "name": { "type": "string", "nullable": true }, "preamble": { "type": "string", "nullable": true }, "terminationSent": { "type": "boolean" }, "terminationReceived": { "type": "boolean" }, "agentContract": { "type": "boolean" }, "relatedContracts": { "type": "array", "items": { "type": "string" }, "nullable": true }, "contractType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS_PARTNER": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" }, "agentId": { "type": "string", "nullable": true }, "countryId": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_MESSAGE" } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACTS_PAYLOAD_INNER": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_CONTRACT" } } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACT_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACTS_CONTRACT" } }, "additionalProperties": false }, "MESG_CONTRACTS_CONTRACT_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_CONTRACTS_CONTRACT_MESSAGE" } }, "additionalProperties": false }, "MESG_COUNTRY_REGISTRY_COUNTRIES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES_PAYLOAD_OUTER" } }, "additionalProperties": false }, "MESG_COUNTRY_REGISTRY_COUNTRIES_COUNTRY": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "maxLength": 5, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" } }, "additionalProperties": false }, "MESG_COUNTRY_REGISTRY_COUNTRIES_PAYLOAD_INNER": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES_COUNTRY" } } }, "additionalProperties": false }, "MESG_COUNTRY_REGISTRY_COUNTRIES_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES_PAYLOAD_OUTER_MESSAGE" } }, "additionalProperties": false }, "MESG_COUNTRY_REGISTRY_COUNTRIES_PAYLOAD_OUTER_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_COUNTRY_REGISTRY_COUNTRIES_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_EXPERTS_EXPERTS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS_PAYLOAD" } }, "additionalProperties": false }, "MESG_EXPERTS_EXPERTS_EXPERT": { "type": "object", "properties": { "category": { "maxLength": 19, "minLength": 9, "type": "string" }, "entry": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS_EXPERT_ENTRY" } }, "additionalProperties": false }, "MESG_EXPERTS_EXPERTS_EXPERT_ENTRY": { "type": "object", "properties": { "category": { "maxLength": 19, "minLength": 9, "type": "string" }, "current": { "maximum": 5, "minimum": 0, "type": "integer", "format": "int32" }, "limit": { "maximum": 5, "minimum": 0, "type": "integer", "format": "int32" }, "available": { "maximum": 5, "minimum": 0, "type": "integer", "format": "int32" }, "efficiencyGain": { "maximum": 29, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_EXPERTS_EXPERTS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_EXPERTS_EXPERTS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS_MESSAGE" } }, "additionalProperties": false }, "MESG_EXPERTS_EXPERTS_PAYLOAD_INNER": { "type": "object", "properties": { "siteId": { "maxLength": 32, "minLength": 32, "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "total": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "active": { "maximum": 5, "minimum": 0, "type": "integer", "format": "int32" }, "totalActiveCap": { "maximum": 6, "minimum": 0, "type": "integer", "format": "int32" }, "experts": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_EXPERTS_EXPERTS_EXPERT" } } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_PAYLOAD" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_BUYINGORDER": { "type": "object", "properties": { "id": { "type": "string" }, "trader": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "amount": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "limit": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_DATA": { "type": "object", "properties": { "base": { "type": "string" }, "quote": { "type": "string" }, "rate": { "maximum": 1.7976931348623157E+308, "minimum": 0.0001, "type": "number", "format": "double" }, "decimals": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_PAIR": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "quote": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "decimals": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_MESSAGE" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_PAYLOAD_INNER": { "type": "object", "properties": { "id": { "type": "string" }, "ticker": { "type": "string" }, "pair": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_PAIR" }, "price": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_PRICE" }, "bid": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "ask": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "spread": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "sellingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_SELLINGORDER" } }, "buyingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_BUYINGORDER" } }, "lotSize": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "feesFactor": { "maximum": 100, "minimum": 1E-05, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_PRICE": { "type": "object", "properties": { "open": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "low": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "high": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "previous": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "close": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" }, "traded": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "volume": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_VOLUME" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_SELLINGORDER": { "type": "object", "properties": { "id": { "type": "string" }, "trader": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "amount": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "limit": { "$ref": "#/components/schemas/MESG_FOREX_BROKER_DATA_DATA" } }, "additionalProperties": false }, "MESG_FOREX_BROKER_DATA_VOLUME": { "type": "object", "properties": { "amount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "MESG_PRODUCTION_ORDER_ADDED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_ADDED_PAYLOAD" } }, "additionalProperties": false }, "MESG_PRODUCTION_ORDER_ADDED_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_ADDED" } }, "additionalProperties": false }, "MESG_PRODUCTION_ORDER_REMOVED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_PRODUCTION_ORDER_REMOVED_PAYLOAD" } }, "additionalProperties": false }, "MESG_PRODUCTION_ORDER_REMOVED_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_REMOVED" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_PAYLOAD" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_EFFICIENCY_FACTOR": { "type": "object", "properties": { "expertiseCategory": { "type": "string", "nullable": true }, "type": { "type": "string" }, "effectivity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "value": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_INPUT_OR_OUTPUT": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_ORDER": { "type": "object", "properties": { "id": { "type": "string" }, "productionLineId": { "type": "string" }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_INPUT_OR_OUTPUT" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_INPUT_OR_OUTPUT" } }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "started": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completion": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "lastUpdated": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completed": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "halted": { "type": "boolean" }, "productionFee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" }, "recurring": { "type": "boolean" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_MESSAGE" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_PAYLOAD_INNER": { "type": "object", "properties": { "id": { "type": "string" }, "siteId": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "type": { "type": "string" }, "capacity": { "type": "integer", "format": "int32" }, "slots": { "type": "integer", "format": "int32" }, "efficiency": { "maximum": 5, "minimum": 0, "type": "number", "format": "double" }, "condition": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "workforces": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_WORKFORCE" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_ORDER" } }, "productionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_PRODUCTION_TEMPLATE" } }, "efficiencyFactors": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_EFFICIENCY_FACTOR" } } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_PRODUCTION_FACTOR": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "factor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_PRODUCTION_TEMPLATE": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "inputFactors": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_PRODUCTION_FACTOR" } }, "outputFactors": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_PRODUCTION_PRODUCTION_LINE_PRODUCTION_FACTOR" } }, "effortFactor": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "efficiency": { "maximum": 5, "minimum": 0, "type": "number", "format": "double" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "productionFeeFactor": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" } }, "additionalProperties": false }, "MESG_PRODUCTION_PRODUCTION_LINE_WORKFORCE": { "type": "object", "properties": { "level": { "type": "string" }, "efficiency": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_PAYLOAD" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_FLIGHTS": { "type": "object", "properties": { "id": { "type": "string" }, "shipId": { "type": "string" }, "origin": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "destination": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "departure": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "arrival": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_SEGMENT" } }, "currentSegmentIndex": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "stlDistance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "ftlDistance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "aborted": { "type": "boolean" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_MESSAGE" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_PAYLOAD_INNER": { "type": "object", "properties": { "flights": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_FLIGHTS" } } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_SEGMENT": { "type": "object", "properties": { "type": { "type": "string" }, "origin": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_WITH_ORBIT" }, "departure": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "destination": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_WITH_ORBIT" }, "arrival": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "stlDistance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double", "nullable": true }, "stlFuelConsumption": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double", "nullable": true }, "transferEllipse": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE" }, "ftlDistance": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double", "nullable": true }, "ftlFuelConsumption": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double", "nullable": true }, "damage": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE": { "type": "object", "properties": { "startPosition": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE_START_POSITION" }, "targetPosition": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE_TARGET_POSITION" }, "center": { "$ref": "#/components/schemas/MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE_CENTER" }, "alpha": { "type": "number", "format": "double" }, "semiMajorAxis": { "type": "number", "format": "double" }, "semiMinorAxis": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE_CENTER": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE_START_POSITION": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_SHIP_FLIGHT_FLIGHTS_TRANSFER_ELLIPSE_TARGET_POSITION": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_SHIP_SHIPS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS_PAYLOAD" } }, "additionalProperties": false }, "MESG_SHIP_SHIPS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_SHIP_SHIPS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS_MESSAGE" } }, "additionalProperties": false }, "MESG_SHIP_SHIPS_PAYLOAD_INNER": { "type": "object", "properties": { "ships": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_SHIP_SHIPS_SHIPS" } } }, "additionalProperties": false }, "MESG_SHIP_SHIPS_SHIPS": { "type": "object", "properties": { "id": { "type": "string" }, "idShipStore": { "type": "string" }, "idStlFuelStore": { "type": "string" }, "idFtlFuelStore": { "type": "string" }, "registration": { "maxLength": 32, "minLength": 0, "type": "string" }, "name": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "commissioningTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "blueprintNaturalId": { "maxLength": 20, "minLength": 0, "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "flightId": { "type": "string", "nullable": true }, "acceleration": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "thrust": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "mass": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "operatingEmptyMass": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "volume": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "reactorPower": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double", "nullable": true }, "emitterPower": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "stlFuelStoreId": { "type": "string" }, "stlFuelFlowRate": { "type": "number", "format": "double" }, "ftlFuelStoreId": { "type": "string" }, "operatingTimeStl": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "operatingTimeFtl": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "condition": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "lastRepair": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "repairMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "status": { "maxLength": 32, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "MESG_SIMULATION_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SIMULATION_DATA_PAYLOAD" } }, "additionalProperties": false }, "MESG_SIMULATION_DATA_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_SIMULATION_DATA_PAYLOAD_MESSAGE" } }, "additionalProperties": false }, "MESG_SIMULATION_DATA_PAYLOAD_INNER": { "type": "object", "properties": { "simulationInterval": { "type": "integer", "format": "int32" }, "flightSTLFactor": { "type": "integer", "format": "int32" }, "flightFTLFactor": { "type": "integer", "format": "int32" }, "planetaryMotionFactor": { "type": "integer", "format": "int32" }, "parsecLength": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_SIMULATION_DATA_PAYLOAD_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SIMULATION_DATA_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_SITE_PLATFORM_REMOVED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SITE_PLATFORM_REMOVED_PAYLOAD" } }, "additionalProperties": false }, "MESG_SITE_PLATFORM_REMOVED_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_REMOVED" } }, "additionalProperties": false }, "MESG_SITE_SITES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_SITE_SITES_PAYLOAD" } }, "additionalProperties": false }, "MESG_SITE_SITES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/ROOT_SITE_SITES" } }, "additionalProperties": false }, "MESG_WORKFORCE_WORKFORCES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES_PAYLOAD" } }, "additionalProperties": false }, "MESG_WORKFORCE_WORKFORCES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_WORKFORCE_WORKFORCES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES_MESSAGE" } }, "additionalProperties": false }, "MESG_WORKFORCE_WORKFORCES_PAYLOAD_INNER": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "siteId": { "maxLength": 32, "minLength": 32, "type": "string" }, "workforces": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES_WORKFORCE" } } }, "additionalProperties": false }, "MESG_WORKFORCE_WORKFORCES_WORKFORCE": { "type": "object", "properties": { "level": { "maxLength": 10, "minLength": 7, "type": "string" }, "population": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "reserve": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "capacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "required": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "satisfaction": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "needs": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES_WORKFORCE_NEEDS" } } }, "additionalProperties": false }, "MESG_WORKFORCE_WORKFORCES_WORKFORCE_NEEDS": { "type": "object", "properties": { "category": { "maxLength": 32, "minLength": 1, "type": "string" }, "essential": { "type": "boolean" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "satisfaction": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "unitsPerInterval": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "unitsPer100": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_CATEGORIES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES_PAYLOAD_OUTER" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_CATEGORIES_CATEGORY": { "type": "object", "properties": { "children": { "type": "array", "items": { } }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "id": { "maxLength": 32, "minLength": 32, "type": "string" }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" } } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_CATEGORIES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_CATEGORIES_PAYLOAD_INNER": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES_CATEGORY" } } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_CATEGORIES_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_CATEGORIES_MESSAGE" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_PAYLOAD_OUTER" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_BUILDING_RECIPE": { "type": "object", "properties": { "buildingCosts": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "reactorId": { "maxLength": 32, "minLength": 32, "type": "string" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_INFRASTRUCTURE_USAGE": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "ticker": { "maxLength": 4, "minLength": 1, "type": "string" }, "projectIdentifier": { "maxLength": 64, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_INPUT_RECIPE": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "reactorId": { "maxLength": 32, "minLength": 32, "type": "string" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_OUTPUT_RECIPE": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "reactorId": { "maxLength": 32, "minLength": 32, "type": "string" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_PAYLOAD_INNER": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "isResource": { "type": "boolean" }, "resourceType": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "inputRecipes": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_INPUT_RECIPE" } }, "outputRecipes": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_OUTPUT_RECIPE" } }, "buildingRecipes": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_BUILDING_RECIPE" } }, "infrastructureUsage": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_INFRASTRUCTURE_USAGE" } }, "cogcUsage": { "type": "boolean" }, "workforceUsage": { "type": "boolean" } }, "additionalProperties": false }, "MESG_WORLD_MATERIAL_DATA_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_WORLD_MATERIAL_DATA_MESSAGE" } }, "additionalProperties": false }, "MESG_WORLD_REACTOR_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA_PAYLOAD_OUTER" } }, "additionalProperties": false, "description": "APEX Payload for MESG_WORLD_REACTOR_DATA" }, "MESG_WORLD_REACTOR_DATA_BUILDING_COST": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "maximum": 5000, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MESG_WORLD_REACTOR_DATA_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA_PAYLOAD_INNER" } }, "additionalProperties": false }, "MESG_WORLD_REACTOR_DATA_PAYLOAD_INNER": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "ticker": { "type": "string" }, "areaCost": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" }, "expertise": { "maxLength": 32, "minLength": 3, "type": "string", "nullable": true }, "buildingCosts": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA_BUILDING_COST" } }, "workforceCapacities": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA_WORKFORCE_CAPACITY" } }, "recipes": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA_RECIPE" } } }, "additionalProperties": false }, "MESG_WORLD_REACTOR_DATA_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/MESG_WORLD_REACTOR_DATA_MESSAGE" } }, "additionalProperties": false }, "MESG_WORLD_REACTOR_DATA_RECIPE": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" } }, "additionalProperties": false }, "MESG_WORLD_REACTOR_DATA_WORKFORCE_CAPACITY": { "type": "object", "properties": { "level": { "maxLength": 32, "minLength": 3, "type": "string" }, "capacity": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Material": { "type": "object", "properties": { "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "The APEX MaterialId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name of the material" }, "Ticker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "The material's ticker" }, "MaterialCategoryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "The material's category id" }, "Weight": { "maximum": 1.7976931348623157E+308, "minimum": 1E-06, "type": "number", "description": "Weight of the material in tons", "format": "double" }, "Volume": { "maximum": 1.7976931348623157E+308, "minimum": 1E-06, "type": "number", "description": "Volume of the material in m^3", "format": "double" }, "IsResource": { "type": "boolean", "description": "If it's a resource extractable from a planet" }, "ResourceType": { "maxLength": 32, "minLength": 0, "type": "string", "description": "The resource type of the material", "nullable": true }, "InfrastructureUsage": { "type": "boolean", "description": "If this material is used in infrastructure" }, "COGCUsage": { "type": "boolean", "description": "If this material is used in COGC" }, "WorkforceUsage": { "type": "boolean", "description": "If this material is used for workforces" }, "Timestamp": { "type": "string", "description": "The timestamp of the data", "format": "date-time" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true } }, "additionalProperties": false, "description": "Material" }, "MaterialAndAmount": { "type": "object", "properties": { "Ticker": { "type": "string", "description": "Ticker" }, "Amount": { "type": "integer", "description": "Amount", "format": "int32" } }, "additionalProperties": false, "description": "MaterialAndAmount" }, "MaterialCategory": { "type": "object", "properties": { "MaterialCategoryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialCategoryId" }, "CategoryName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CategoryName" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "MaterialCategory" }, "MaterialTickerAndAmount": { "type": "object", "properties": { "Ticker": { "type": "string" }, "Amount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MiscPermissions": { "type": "object", "properties": { "ShipmentTracking": { "type": "boolean", "description": "If shipment tracking is allowed", "default": true } }, "additionalProperties": false, "description": "Misc permissions" }, "PATH_COMMODITY_EXCHANGES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES_PAYLOAD_OUTER" } }, "additionalProperties": false }, "PATH_COMMODITY_EXCHANGES_ADDRESS": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES_LINE" } } }, "additionalProperties": false }, "PATH_COMMODITY_EXCHANGES_BODY": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "code": { "maxLength": 3, "minLength": 3, "type": "string" }, "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "address": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES_ADDRESS" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_COMMODITY_EXCHANGES_LINE": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_ENTITY" }, "type": { "type": "string" } }, "additionalProperties": false }, "PATH_COMMODITY_EXCHANGES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_COMMODITY_EXCHANGES_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES_BODY" } }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_COMMODITY_EXCHANGES_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_COMMODITY_EXCHANGES_MESSAGE" } }, "additionalProperties": false }, "PATH_COMPANIES_OFFICES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES_PAYLOAD" } }, "additionalProperties": false }, "PATH_COMPANIES_OFFICES_BODY": { "type": "object", "properties": { "type": { "maxLength": 20, "minLength": 8, "type": "string" }, "start": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "end": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_COMPANIES_OFFICES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_COMPANIES_OFFICES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES_MESSAGE" } }, "additionalProperties": false }, "PATH_COMPANIES_OFFICES_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_COMPANIES_OFFICES_BODY" } }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_COMPANY": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_COMPANY_PAYLOAD" } }, "additionalProperties": false }, "PATH_COMPANY_BODY": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "maxLength": 4, "minLength": 1, "type": "string" }, "founded": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "user": { "$ref": "#/components/schemas/APEX_COMMON_USER" }, "country": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "corporation": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "ratingReport": { "$ref": "#/components/schemas/PATH_COMPANY_RATINGREPORT" }, "siteAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" } }, "reputation": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_COMPANY_REPUTATION" } }, "currentRepresentationLevel": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_COMPANY_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_COMPANY_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_COMPANY_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_COMPANY_MESSAGE" } }, "additionalProperties": false }, "PATH_COMPANY_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PATH_COMPANY_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_COMPANY_RATINGREPORT": { "type": "object", "properties": { "overallRating": { "maxLength": 7, "minLength": 1, "type": "string" }, "contractCount": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "earliestContract": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "PATH_COMPANY_REPUTATION": { "type": "object", "properties": { "entityId": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "reputation": { "maximum": 10000, "minimum": -1000, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PATH_GATEWAY": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_GATEWAY_PAYLOAD" } }, "additionalProperties": false }, "PATH_GATEWAY_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_GATEWAY_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_GATEWAY_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_GATEWAY_MESSAGE" } }, "additionalProperties": false }, "PATH_GATEWAY_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/GATEWAY_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_LOCALMARKET_AD": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD_PAYLOAD" } }, "additionalProperties": false }, "PATH_LOCALMARKET_AD_BODY": { "type": "object", "properties": { "origin": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "destination": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "cargoWeight": { "maximum": 100000, "minimum": 1E-05, "type": "number", "format": "double", "nullable": true }, "cargoVolume": { "maximum": 100000, "minimum": 1E-05, "type": "number", "format": "double", "nullable": true }, "localMarketId": { "type": "string" }, "naturalId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "status": { "maxLength": 64, "minLength": 3, "type": "string" }, "creator": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "type": { "maxLength": 20, "minLength": 3, "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "quantity": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" }, "price": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "advice": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" }, "creationTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "minimumRating": { "maxLength": 7, "minLength": 1, "type": "string" }, "expiry": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_LOCALMARKET_AD_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_LOCALMARKET_AD_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD_MESSAGE" } }, "additionalProperties": false }, "PATH_LOCALMARKET_AD_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_LOCALMARKET_AD_BODY" } }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_PLANETS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_PLANETS_PAYLOAD" } }, "additionalProperties": false }, "PATH_PLANETS_BILL_OF_MATERIAL": { "type": "object", "properties": { "quantities": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } } }, "additionalProperties": false }, "PATH_PLANETS_BODY": { "type": "object", "properties": { "planetId": { "type": "string" }, "naturalId": { "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string", "nullable": true }, "namer": { "$ref": "#/components/schemas/APEX_COMMON_USER" }, "namingDate": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "nameable": { "type": "boolean" }, "celestialBodies": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PLANET_CELESTIAL_BODY" } }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "data": { "$ref": "#/components/schemas/PATH_PLANETS_DATA" }, "adminCenterId": { "type": "string", "nullable": true }, "buildOptions": { "$ref": "#/components/schemas/PATH_PLANETS_BUILD_OPTIONS" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PLANETS_PROJECT" } }, "country": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "governingEntity": { "type": "string", "nullable": true }, "localRules": { "$ref": "#/components/schemas/PATH_PLANETS_LOCAL_RULES" }, "populationId": { "type": "string" }, "cogcId": { "type": "string" }, "supportsGhostSites": { "type": "boolean" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_PLANETS_BUILD_OPTION": { "type": "object", "properties": { "siteType": { "type": "string" }, "feeReceiver": { "type": "string", "nullable": true }, "costs": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "billOfMaterial": { "$ref": "#/components/schemas/PATH_PLANETS_BILL_OF_MATERIAL" } }, "additionalProperties": false }, "PATH_PLANETS_BUILD_OPTIONS": { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PLANETS_BUILD_OPTION" } } }, "additionalProperties": false }, "PATH_PLANETS_COLLECTOR": { "type": "object", "properties": { "_proxy_key": { "type": "string" }, "_type": { "type": "string" }, "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" } }, "additionalProperties": false }, "PATH_PLANETS_DATA": { "type": "object", "properties": { "gravity": { "type": "number", "format": "double" }, "magneticField": { "type": "number", "format": "double" }, "mass": { "type": "number", "format": "double" }, "massEarth": { "type": "number", "format": "double" }, "orbit": { "$ref": "#/components/schemas/PATH_PLANETS_ORBIT" }, "orbitIndex": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "pressure": { "type": "number", "format": "double" }, "radiation": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PLANETS_RESOURCE" } }, "sunlight": { "type": "number", "format": "double" }, "surface": { "type": "boolean" }, "temperature": { "type": "number", "format": "double" }, "plots": { "type": "integer", "format": "int32" }, "fertility": { "maximum": 1, "minimum": -1, "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "PATH_PLANETS_ESTABLISHMENT_FEE": { "type": "object", "properties": { "fee": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PATH_PLANETS_FEE": { "type": "object", "properties": { "category": { "type": "string" }, "workforceLevel": { "type": "string" }, "fee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" } }, "additionalProperties": false }, "PATH_PLANETS_LOCAL_MARKET_FEE": { "type": "object", "properties": { "base": { "type": "integer", "format": "int32" }, "timeFactor": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PATH_PLANETS_LOCAL_RULES": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "collector": { "$ref": "#/components/schemas/PATH_PLANETS_COLLECTOR" }, "productionFees": { "$ref": "#/components/schemas/PATH_PLANETS_PRODUCTION_FEES" }, "productionFeeLimitFactors": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "localMarketFee": { "$ref": "#/components/schemas/PATH_PLANETS_LOCAL_MARKET_FEE" }, "siteEstablishmentFee": { "$ref": "#/components/schemas/PATH_PLANETS_ESTABLISHMENT_FEE" }, "warehouseFee": { "$ref": "#/components/schemas/PATH_PLANETS_WAREHOUSE_FEE" } }, "additionalProperties": false }, "PATH_PLANETS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_PLANETS_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_PLANETS_ORBIT": { "type": "object", "properties": { "semiMajorAxis": { "type": "number", "format": "double" }, "eccentricity": { "type": "number", "format": "double" }, "inclination": { "type": "number", "format": "double" }, "rightAscension": { "type": "number", "format": "double" }, "periapsis": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PATH_PLANETS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_PLANETS_MESSAGE" } }, "additionalProperties": false }, "PATH_PLANETS_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PATH_PLANETS_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_PLANETS_PRODUCTION_FEES": { "type": "object", "properties": { "fees": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PLANETS_FEE" } } }, "additionalProperties": false }, "PATH_PLANETS_PROJECT": { "type": "object", "properties": { "type": { "type": "string" }, "entityId": { "type": "string" } }, "additionalProperties": false }, "PATH_PLANETS_RESOURCE": { "type": "object", "properties": { "materialId": { "type": "string" }, "type": { "type": "string" }, "factor": { "maximum": 1, "minimum": 1E-05, "type": "number", "format": "double" } }, "additionalProperties": false }, "PATH_PLANETS_WAREHOUSE_FEE": { "type": "object", "properties": { "fee": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PATH_PLANET_CELESTIAL_BODY": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_WITH_ORBIT" }, "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "naturalId": { "type": "string" }, "orbit": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_ORBIT" } }, "additionalProperties": false }, "PATH_PROJECT": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_PROJECT_PAYLOAD_OUTER" } }, "additionalProperties": false }, "PATH_PROJECT_BODY": { "type": "object", "properties": { "type": { "maxLength": 26, "minLength": 7, "type": "string" }, "projectIdentifier": { "maxLength": 64, "minLength": 2, "type": "string" }, "level": { "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32" }, "activeLevel": { "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32" }, "currentLevel": { "maximum": 2147483647, "minimum": -1, "type": "integer", "format": "int32" }, "upgradeCosts": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PROJECT_UPGRADE_COST" }, "nullable": true }, "upgradeStatus": { "type": "number", "format": "double" }, "upkeeps": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PROJECT_UPKEEP" }, "nullable": true }, "contributions": { "type": "array", "items": { "$ref": "#/components/schemas/PATH_PROJECT_CONTRIBUTION" } }, "id": { "maxLength": 32, "minLength": 32, "type": "string" } }, "additionalProperties": false }, "PATH_PROJECT_CONTRIBUTION": { "type": "object", "properties": { "materials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "contributor": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" } }, "additionalProperties": false }, "PATH_PROJECT_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_PROJECT_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_PROJECT_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PATH_PROJECT_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_PROJECT_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_PROJECT_MESSAGE" } }, "additionalProperties": false }, "PATH_PROJECT_UPGRADE_COST": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "currentAmount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PATH_PROJECT_UPKEEP": { "type": "object", "properties": { "stored": { "type": "number", "format": "double" }, "storeCapacity": { "type": "number", "format": "double" }, "duration": { "type": "integer", "format": "int64" }, "nextTick": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "type": "integer", "format": "int32" }, "currentAmount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PATH_STATION": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_STATION_PAYLOAD_OUTER" } }, "additionalProperties": false }, "PATH_STATION_BODY": { "type": "object", "properties": { "naturalId": { "type": "string" }, "name": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "commissioningTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "comex": { "$ref": "#/components/schemas/PATH_STATION_COMEX" }, "warehouseId": { "type": "string" }, "localMarketId": { "type": "string" }, "country": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "currency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "governingEntity": { "$ref": "#/components/schemas/PATH_STATION_GOVERNING_ENTITY" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_STATION_COMEX": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "code": { "type": "string" }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "PATH_STATION_GOVERNING_ENTITY": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" } }, "additionalProperties": false }, "PATH_STATION_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_STATION_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_STATION_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PATH_STATION_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PATH_STATION_PAYLOAD_OUTER": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_STATION_MESSAGE" } }, "additionalProperties": false }, "PATH_USERS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_USERS_PAYLOAD" } }, "additionalProperties": false }, "PATH_USERS_BODY": { "type": "object", "properties": { "username": { "maxLength": 64, "minLength": 2, "type": "string" }, "subscriptionLevel": { "maxLength": 5, "minLength": 3, "type": "string" }, "highestTier": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "pioneer": { "type": "boolean" }, "moderator": { "type": "boolean" }, "team": { "type": "boolean" }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "company": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "activeDaysPerWeek": { "type": "integer", "format": "int32" }, "id": { "type": "string" } }, "additionalProperties": false }, "PATH_USERS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PATH_USERS_PAYLOAD_INNER" } }, "additionalProperties": false }, "PATH_USERS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PATH_USERS_MESSAGE" } }, "additionalProperties": false }, "PATH_USERS_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PATH_USERS_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PLANET_COGC_BILL_OF_MATERIAL": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "currentAmount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PLANET_COGC_CONTRIBUTION": { "type": "object", "properties": { "materials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "contributor": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" } }, "additionalProperties": false }, "PLANET_COGC_HISTORY": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY_PAYLOAD" } }, "additionalProperties": false }, "PLANET_COGC_HISTORY_BODY": { "type": "object", "properties": { "planet": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS_ENTITY" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "completionDate": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "status": { "type": "string" }, "programs": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_COGC_PROGRAM" } }, "votes": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_COGC_VOTE" } }, "programTypes": { "type": "array", "items": { "type": "string" } }, "upkeep": { "$ref": "#/components/schemas/PLANET_COGC_UPKEEP" }, "id": { "type": "string" } }, "additionalProperties": false }, "PLANET_COGC_HISTORY_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY_PAYLOAD_INNER" } }, "additionalProperties": false }, "PLANET_COGC_HISTORY_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY_MESSAGE" } }, "additionalProperties": false }, "PLANET_COGC_HISTORY_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PLANET_COGC_HISTORY_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PLANET_COGC_PROGRAM": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "start": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "end": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "PLANET_COGC_UPKEEP": { "type": "object", "properties": { "billOfMaterial": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_COGC_BILL_OF_MATERIAL" } }, "contributions": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_COGC_CONTRIBUTION" } }, "dueDate": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "PLANET_COGC_VOTE": { "type": "object", "properties": { "voter": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE" }, "influence": { "type": "number", "format": "double" }, "type": { "type": "string" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_PAYLOAD" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_AVERAGE_HAPPINESS": { "type": "object", "properties": { "PIONEER": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "SETTLER": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "TECHNICIAN": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "ENGINEER": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "SCIENTIST": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_BODY": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_REPORT" } }, "infrastructure": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_INFRASTRUCTURE" } }, "id": { "type": "string" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_INFRASTRUCTURE": { "type": "object", "properties": { "type": { "maxLength": 64, "minLength": 0, "type": "string" }, "ticker": { "type": "string" }, "projectId": { "type": "string" }, "projectName": { "maxLength": 64, "minLength": 0, "type": "string" }, "level": { "maximum": 10, "minimum": 0, "type": "integer", "format": "int32" }, "activeLevel": { "maximum": 10, "minimum": -1, "type": "integer", "format": "int32" }, "currentLevel": { "maximum": 10, "minimum": 0, "type": "integer", "format": "int32" }, "upkeepStatus": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "upgradeStatus": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_PAYLOAD_INNER" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_NEED_FULFILLMENT": { "type": "object", "properties": { "LIFE_SUPPORT": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "SAFETY": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "HEALTH": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "COMFORT": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "CULTURE": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "EDUCATION": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_NEXT_POPULATION": { "type": "object", "properties": { "PIONEER": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "SETTLER": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "TECHNICIAN": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "ENGINEER": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "SCIENTIST": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_OPEN_JOBS": { "type": "object", "properties": { "PIONEER": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "SETTLER": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "TECHNICIAN": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "ENGINEER": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "SCIENTIST": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_MESSAGE" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_BODY" }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_PER_PROJECT_NEED_FULFILLMENT": { "type": "object", "properties": { "infrastructureType": { "maxLength": 64, "minLength": 0, "type": "string" }, "needType": { "maxLength": 64, "minLength": 0, "type": "string" }, "fulfillment": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_POPULATION_CHANGE": { "type": "object", "properties": { "PIONEER": { "type": "integer", "format": "int32" }, "SETTLER": { "type": "integer", "format": "int32" }, "TECHNICIAN": { "type": "integer", "format": "int32" }, "ENGINEER": { "type": "integer", "format": "int32" }, "SCIENTIST": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_POPULATION_DIFFERENCE": { "type": "object", "properties": { "PIONEER": { "type": "integer", "format": "int32" }, "SETTLER": { "type": "integer", "format": "int32" }, "TECHNICIAN": { "type": "integer", "format": "int32" }, "ENGINEER": { "type": "integer", "format": "int32" }, "SCIENTIST": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_POPULATION_SHIFT": { "type": "object", "properties": { "PIONEER": { "type": "integer", "format": "int32" }, "SETTLER": { "type": "integer", "format": "int32" }, "TECHNICIAN": { "type": "integer", "format": "int32" }, "ENGINEER": { "type": "integer", "format": "int32" }, "SCIENTIST": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_REPORT": { "type": "object", "properties": { "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "simulationPeriod": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "explorersGraceEnabled": { "type": "boolean" }, "nextPopulation": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_NEXT_POPULATION" }, "populationDifference": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_POPULATION_DIFFERENCE" }, "populationChange": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_POPULATION_CHANGE" }, "populationShift": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_POPULATION_SHIFT" }, "averageHappiness": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_AVERAGE_HAPPINESS" }, "unemploymentRate": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_UNEMPLOYMENT_RATE" }, "openJobs": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_OPEN_JOBS" }, "needFulfillment": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_NEED_FULFILLMENT" }, "needFulfillments": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_POPULATION_REPORT_PER_PROJECT_NEED_FULFILLMENT" } }, "governmentProgramType": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "PLANET_POPULATION_REPORT_UNEMPLOYMENT_RATE": { "type": "object", "properties": { "PIONEER": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "SETTLER": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "TECHNICIAN": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "ENGINEER": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "SCIENTIST": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "PLANET_SITES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PLANET_SITE_PAYLOAD" } }, "additionalProperties": false }, "PLANET_SITE_BODY": { "type": "object", "properties": { "planetId": { "type": "string" }, "ownerId": { "type": "string" }, "entity": { "$ref": "#/components/schemas/PLANET_SITE_ENTITY" }, "type": { "type": "string" }, "plot": { "type": "integer", "format": "int32" }, "id": { "type": "string" } }, "additionalProperties": false }, "PLANET_SITE_ENTITY": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "code": { "maxLength": 4, "minLength": 1, "type": "string", "nullable": true }, "_type": { "type": "string" }, "_proxy_key": { "type": "string" }, "naturalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PLANET_SITE_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/PLANET_SITE_PAYLOAD_INNER" } }, "additionalProperties": false }, "PLANET_SITE_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/PLANET_SITE_MESSAGE" } }, "additionalProperties": false }, "PLANET_SITE_PAYLOAD_INNER": { "type": "object", "properties": { "body": { "type": "array", "items": { "$ref": "#/components/schemas/PLANET_SITE_BODY" } }, "path": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PermissionResponse": { "type": "object", "properties": { "GrantorUserName": { "type": "string", "description": "The grantor of permissions" }, "GranteeUserName": { "type": "string", "description": "The grantee of permissions" }, "GroupId": { "type": "integer", "description": "GroupId of the permission", "format": "int32" }, "Permissions": { "$ref": "#/components/schemas/Permissions" } }, "additionalProperties": false, "description": "Response representing a Permission Model" }, "Permissions": { "type": "object", "properties": { "ShipPermissions": { "$ref": "#/components/schemas/ShipPermissions" }, "SitesPermissions": { "$ref": "#/components/schemas/SitePermissions" }, "StoragePermissions": { "$ref": "#/components/schemas/StoragePermissions" }, "TradePermissions": { "$ref": "#/components/schemas/TradePermissions" }, "CompanyPermissions": { "$ref": "#/components/schemas/CompanyPermissions" }, "MiscPermissions": { "$ref": "#/components/schemas/MiscPermissions" } }, "additionalProperties": false, "description": "Permissions" }, "PhaseUpkeep": { "type": "object", "properties": { "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "Current": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Current", "format": "int32" }, "Required": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Required", "format": "int32" } }, "additionalProperties": false, "description": "PhaseUpkeep" }, "Planet": { "type": "object", "properties": { "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId" }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "NamerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "NamerId", "nullable": true }, "NamerUserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "NamerUserName", "nullable": true }, "NamedTimestamp": { "type": "string", "description": "NamedTimestamp", "format": "date-time", "nullable": true }, "Nameable": { "type": "boolean", "description": "Nameable" }, "Gravity": { "type": "number", "description": "Gravity", "format": "double" }, "MagneticField": { "type": "number", "description": "MagneticField", "format": "double" }, "Mass": { "type": "number", "description": "Mass", "format": "double" }, "MassEarth": { "type": "number", "description": "MassEarth", "format": "double" }, "SemiMajorAxis": { "type": "number", "description": "SemiMajorAxis", "format": "double" }, "Eccentricity": { "type": "number", "description": "Eccentricity", "format": "double" }, "Inclination": { "type": "number", "description": "Inclination", "format": "double" }, "RightAscension": { "type": "number", "description": "RightAscension", "format": "double" }, "Periapsis": { "type": "number", "description": "Periapsis", "format": "double" }, "OrbitIndex": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "OrbitIndex", "format": "int32" }, "Pressure": { "type": "number", "description": "Pressure", "format": "double" }, "Radiation": { "type": "number", "description": "Radiation", "format": "double" }, "Radius": { "type": "number", "description": "Radius", "format": "double" }, "Sunlight": { "type": "number", "description": "Sunlight", "format": "double" }, "Temperature": { "type": "number", "description": "Temperature", "format": "double" }, "Fertility": { "maximum": 1, "minimum": -1, "type": "number", "description": "Fertility", "format": "double", "nullable": true }, "Surface": { "type": "boolean", "description": "Surface" }, "Plots": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Plots", "format": "int32" }, "CountryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CountryId", "nullable": true }, "CountryName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CountryName", "nullable": true }, "CountryCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CountryCode", "nullable": true }, "GoverningEntity": { "maxLength": 32, "minLength": 32, "type": "string", "description": "GoverningEntity", "nullable": true }, "CurrencyNumericCode": { "type": "integer", "description": "CurrencyNumericCode", "format": "int32", "nullable": true }, "CurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "CurrencyCode", "nullable": true }, "CurrencyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CurrencyName", "nullable": true }, "CollectionCurrencyNumericCode": { "type": "integer", "description": "CollectionCurrencyNumericCode", "format": "int32", "nullable": true }, "CollectionCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "CollectionCurrencyCode", "nullable": true }, "CollectionCurrencyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CollectionCurrencyName", "nullable": true }, "LocalMarketFeeBase": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LocalMarketFeeBase", "format": "double", "nullable": true }, "LocalMarketTimeFactor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LocalMarketTimeFactor", "format": "double", "nullable": true }, "EstablishmentFee": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "EstablishmentFee", "format": "double", "nullable": true }, "WarehouseFee": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "WarehouseFee", "format": "double", "nullable": true }, "PopulationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PopulationId", "nullable": true }, "ChamberOfCommerceId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ChamberOfCommerceId", "nullable": true }, "WarehouseId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "WarehouseId", "nullable": true }, "LocalMarketId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocalMarketId", "nullable": true }, "AdministrationCenterId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "AdministrationCenterId", "nullable": true }, "ShipyardId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ShipyardId", "nullable": true }, "SupportsGhostSites": { "type": "boolean", "description": "SupportsGhostSizes" }, "CurrentCOGCProgram": { "maxLength": 31, "minLength": 18, "type": "string", "description": "COGCProgram", "nullable": true }, "CurrentCOGCProgramEndTime": { "type": "string", "description": "LastCOGCProgramUpdate", "format": "date-time" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetResource" }, "description": "Resources" }, "WorkforceFees": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetWorkforceFee" }, "description": "WorkforceFees" }, "COGCPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetCOGCProgram" }, "description": "COGCPrograms" }, "PopulationReports": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetPopulationReport" }, "description": "PopulationReports" }, "CelestialBodies": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetCelestialBody" }, "description": "CelestialBodies" }, "HasShipyard": { "type": "boolean", "description": "HasShipyard" }, "HasAdministrationCenter": { "type": "boolean", "description": "HasAdministrationCenter" }, "HasChamberOfCommerce": { "type": "boolean", "description": "HasCOGC" }, "HasWarehouse": { "type": "boolean", "description": "HasWarehouse" }, "HasLocalMarket": { "type": "boolean", "description": "HasLocalMarket" }, "Rocky": { "type": "boolean", "description": "If planet requires MCG" }, "Gaseous": { "type": "boolean", "description": "If planet requires AEF" }, "LowGravity": { "type": "boolean", "description": "If planet requires MGC" }, "HighGravity": { "type": "boolean", "description": "If planet requires BL" }, "LowPressure": { "type": "boolean", "description": "If planet requires SEA" }, "HighPressure": { "type": "boolean", "description": "If planet requires HSE" }, "LowTemperature": { "type": "boolean", "description": "If planet requires INS" }, "HighTemperature": { "type": "boolean", "description": "If planet requires TSH" }, "Fertile": { "type": "boolean", "description": "If the planet is fertile" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "nullable": true, "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true } }, "additionalProperties": false, "description": "Planet Model" }, "PlanetCOGCProgram": { "type": "object", "properties": { "Type": { "maxLength": 31, "minLength": 18, "type": "string", "description": "Type", "nullable": true }, "StartTime": { "type": "string", "description": "StartTime", "format": "date-time" }, "EndTime": { "type": "string", "description": "EndTime", "format": "date-time" }, "Votes": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetCOGCVote" }, "description": "Votes" } }, "additionalProperties": false, "description": "PlanetCOGCHistory" }, "PlanetCOGCVote": { "type": "object", "properties": { "Type": { "maxLength": 31, "minLength": 18, "type": "string", "description": "Type", "nullable": true }, "Time": { "type": "string", "description": "Time", "format": "date-time" }, "Influence": { "type": "number", "description": "Influence", "format": "double" }, "CompanyId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CompanyId (Voter)" } }, "additionalProperties": false, "description": "A vote on a COGC Program" }, "PlanetCelestialBody": { "type": "object", "properties": { "PlanetCelestialBodyId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetCelestialBodyId" }, "Type": { "maxLength": 32, "minLength": 0, "type": "string", "description": "Type" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "Eccentricity": { "type": "number", "description": "Eccentricity", "format": "double" }, "Inclination": { "type": "number", "description": "Inclination", "format": "double" }, "Periapsis": { "type": "number", "description": "Periapsis", "format": "double" }, "RightAscension": { "type": "number", "description": "RightAscension", "format": "double" }, "SemiMajorAxis": { "type": "number", "description": "SemiMajorAxis", "format": "double" } }, "additionalProperties": false, "description": "PlanetCelestialBody" }, "PlanetPopulationReport": { "type": "object", "properties": { "PlanetPopulationReportId": { "maxLength": 40, "minLength": 0, "type": "string", "description": "PlanetPopulationReportId: {PlanetId}-{SimulationPeriod}" }, "SimulationPeriod": { "type": "integer", "description": "SimulationPeriod", "format": "int32" }, "ExplorersGraceEnabled": { "type": "boolean", "description": "ExplorersGraceEnabled" }, "ReportTimestamp": { "type": "string", "description": "Report", "format": "date-time" }, "NextPopulationPioneer": { "type": "integer", "description": "NextPopulationPioneer", "format": "int32" }, "NextPopulationSettler": { "type": "integer", "description": "NextPopulationSettler", "format": "int32" }, "NextPopulationTechnician": { "type": "integer", "description": "NextPopulationTechnician", "format": "int32" }, "NextPopulationEngineer": { "type": "integer", "description": "NextPopulationEngineer", "format": "int32" }, "NextPopulationScientist": { "type": "integer", "description": "NextPopulationScientist", "format": "int32" }, "PopulationDifferencePioneer": { "type": "integer", "description": "PopulationDifferencePioneer", "format": "int32" }, "PopulationDifferenceSettler": { "type": "integer", "description": "PopulationDifferenceSettler", "format": "int32" }, "PopulationDifferenceTechnician": { "type": "integer", "description": "PopulationDifferenceTechnician", "format": "int32" }, "PopulationDifferenceEngineer": { "type": "integer", "description": "PopulationDifferenceEngineer", "format": "int32" }, "PopulationDifferenceScientist": { "type": "integer", "description": "PopulationDifferenceScientist", "format": "int32" }, "AverageHappinessPioneer": { "type": "number", "description": "AverageHappinessPioneer", "format": "double" }, "AverageHappinessSettler": { "type": "number", "description": "AverageHappinessSettler", "format": "double" }, "AverageHappinessTechnician": { "type": "number", "description": "AverageHappinessTechnician", "format": "double" }, "AverageHappinessEngineer": { "type": "number", "description": "AverageHappinessEngineer", "format": "double" }, "AverageHappinessScientist": { "type": "number", "description": "AverageHappinessScientist", "format": "double" }, "UnemploymentRatePioneer": { "type": "number", "description": "UnemploymentRatePioneer", "format": "double" }, "UnemploymentRateSettler": { "type": "number", "description": "UnemploymentRateSettler", "format": "double" }, "UnemploymentRateTechnician": { "type": "number", "description": "UnemploymentRateTechnician", "format": "double" }, "UnemploymentRateEngineer": { "type": "number", "description": "UnemploymentRateEngineer", "format": "double" }, "UnemploymentRateScientist": { "type": "number", "description": "UnemploymentRateScientist", "format": "double" }, "OpenJobsPioneer": { "type": "number", "description": "OpenJobsPioneer", "format": "double" }, "OpenJobsSettler": { "type": "number", "description": "OpenJobsSettler", "format": "double" }, "OpenJobsTechnician": { "type": "number", "description": "OpenJobsTechnician", "format": "double" }, "OpenJobsEngineer": { "type": "number", "description": "OpenJobsEngineer", "format": "double" }, "OpenJobsScientist": { "type": "number", "description": "OpenJobsScientist", "format": "double" }, "NeedFulfillmentLifeSupport": { "type": "number", "description": "NeedFulfillmentLifeSupport", "format": "double" }, "NeedFulfillmentSafety": { "type": "number", "description": "NeedFulfillmentSafety", "format": "double" }, "NeedFulfillmentHealth": { "type": "number", "description": "NeedFulfillmentHealth", "format": "double" }, "NeedFulfillmentComfort": { "type": "number", "description": "NeedFulfillmentComfort", "format": "double" }, "NeedFulfillmentCulture": { "type": "number", "description": "NeedFulfillmentCulture", "format": "double" }, "NeedFulfillmentEducation": { "type": "number", "description": "NeedFulfillmentEducation", "format": "double" } }, "additionalProperties": false, "description": "PlanetPopulationReport" }, "PlanetResource": { "type": "object", "properties": { "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialId" }, "Type": { "maxLength": 7, "minLength": 6, "type": "string", "description": "Type (resource type)" }, "Concentration": { "type": "number", "description": "Resource concentration", "format": "double" } }, "additionalProperties": false, "description": "PlanetResource" }, "PlanetSearch": { "type": "object", "properties": { "Materials": { "type": "array", "items": { "type": "string" }, "description": "The material tickers to search for" }, "ConcentrationThreshold": { "maximum": 1, "minimum": 0, "type": "number", "description": "Omit any material results with a concentration less than this value", "format": "double" }, "IncludeRocky": { "type": "boolean", "description": "Include rocky planets" }, "IncludeGaseous": { "type": "boolean", "description": "Include gaseous planets" }, "IncludeLowGravity": { "type": "boolean", "description": "Include low gravity planets" }, "IncludeHighGravity": { "type": "boolean", "description": "Include high gravity planets" }, "IncludeLowPressure": { "type": "boolean", "description": "Include low pressure planets" }, "IncludeHighPressure": { "type": "boolean", "description": "Include high pressure planets" }, "IncludeLowTemperature": { "type": "boolean", "description": "Include low temperature planets" }, "IncludeHighTemperature": { "type": "boolean", "description": "Include high temperature planets" }, "MustBeFertile": { "type": "boolean", "description": "The planet must be fertile" }, "MustHaveLocalMarket": { "type": "boolean", "description": "The planet must have a local market" }, "MustHaveChamberOfCommerce": { "type": "boolean", "description": "The planet must have a chamber of global commerce" }, "MustHaveWarehouse": { "type": "boolean", "description": "The planet must have a warehouse" }, "MustHaveAdministrationCenter": { "type": "boolean", "description": "The planet must have an administration center" }, "MustHaveShipyard": { "type": "boolean", "description": "The planet must have a shipyard" }, "DistanceChecks": { "type": "array", "items": { "type": "string" }, "description": "Where to do distance checks from (maximum 10)" }, "JumpDistanceThreshold": { "maximum": 2147483647, "minimum": -1, "type": "integer", "description": "The jump distance threshold from the source below", "format": "int32" }, "JumpDistanceThresholdSource": { "maxLength": 64, "minLength": 0, "type": "string", "description": "What source to threshold from. Can be SystemID, System Name, Planet Name, Planet NaturalId, Planet Id", "nullable": true } }, "additionalProperties": false, "description": "The payload search payload to POST" }, "PlanetSearchResult": { "type": "object", "properties": { "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId" }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "NamerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "NamerId", "nullable": true }, "NamerUserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "NamerUserName", "nullable": true }, "NamedTimestamp": { "type": "string", "description": "NamedTimestamp", "format": "date-time", "nullable": true }, "Nameable": { "type": "boolean", "description": "Nameable" }, "Gravity": { "type": "number", "description": "Gravity", "format": "double" }, "MagneticField": { "type": "number", "description": "MagneticField", "format": "double" }, "Mass": { "type": "number", "description": "Mass", "format": "double" }, "MassEarth": { "type": "number", "description": "MassEarth", "format": "double" }, "SemiMajorAxis": { "type": "number", "description": "SemiMajorAxis", "format": "double" }, "Eccentricity": { "type": "number", "description": "Eccentricity", "format": "double" }, "Inclination": { "type": "number", "description": "Inclination", "format": "double" }, "RightAscension": { "type": "number", "description": "RightAscension", "format": "double" }, "Periapsis": { "type": "number", "description": "Periapsis", "format": "double" }, "OrbitIndex": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "OrbitIndex", "format": "int32" }, "Pressure": { "type": "number", "description": "Pressure", "format": "double" }, "Radiation": { "type": "number", "description": "Radiation", "format": "double" }, "Radius": { "type": "number", "description": "Radius", "format": "double" }, "Sunlight": { "type": "number", "description": "Sunlight", "format": "double" }, "Temperature": { "type": "number", "description": "Temperature", "format": "double" }, "Fertility": { "maximum": 1, "minimum": -1, "type": "number", "description": "Fertility", "format": "double", "nullable": true }, "Surface": { "type": "boolean", "description": "Surface" }, "Plots": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Plots", "format": "int32" }, "CountryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CountryId", "nullable": true }, "CountryName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CountryName", "nullable": true }, "CountryCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "CountryCode", "nullable": true }, "GoverningEntity": { "maxLength": 32, "minLength": 32, "type": "string", "description": "GoverningEntity", "nullable": true }, "CurrencyNumericCode": { "type": "integer", "description": "CurrencyNumericCode", "format": "int32", "nullable": true }, "CurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "CurrencyCode", "nullable": true }, "CurrencyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CurrencyName", "nullable": true }, "CollectionCurrencyNumericCode": { "type": "integer", "description": "CollectionCurrencyNumericCode", "format": "int32", "nullable": true }, "CollectionCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "CollectionCurrencyCode", "nullable": true }, "CollectionCurrencyName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CollectionCurrencyName", "nullable": true }, "LocalMarketFeeBase": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LocalMarketFeeBase", "format": "double", "nullable": true }, "LocalMarketTimeFactor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "LocalMarketTimeFactor", "format": "double", "nullable": true }, "EstablishmentFee": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "EstablishmentFee", "format": "double", "nullable": true }, "WarehouseFee": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "WarehouseFee", "format": "double", "nullable": true }, "PopulationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PopulationId", "nullable": true }, "ChamberOfCommerceId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ChamberOfCommerceId", "nullable": true }, "WarehouseId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "WarehouseId", "nullable": true }, "LocalMarketId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocalMarketId", "nullable": true }, "AdministrationCenterId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "AdministrationCenterId", "nullable": true }, "ShipyardId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ShipyardId", "nullable": true }, "SupportsGhostSites": { "type": "boolean", "description": "SupportsGhostSizes" }, "CurrentCOGCProgram": { "maxLength": 31, "minLength": 18, "type": "string", "description": "COGCProgram", "nullable": true }, "CurrentCOGCProgramEndTime": { "type": "string", "description": "LastCOGCProgramUpdate", "format": "date-time" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetResource" }, "description": "Resources" }, "WorkforceFees": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetWorkforceFee" }, "description": "WorkforceFees" }, "COGCPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetCOGCProgram" }, "description": "COGCPrograms" }, "PopulationReports": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetPopulationReport" }, "description": "PopulationReports" }, "CelestialBodies": { "type": "array", "items": { "$ref": "#/components/schemas/PlanetCelestialBody" }, "description": "CelestialBodies" }, "HasShipyard": { "type": "boolean", "description": "HasShipyard" }, "HasAdministrationCenter": { "type": "boolean", "description": "HasAdministrationCenter" }, "HasChamberOfCommerce": { "type": "boolean", "description": "HasCOGC" }, "HasWarehouse": { "type": "boolean", "description": "HasWarehouse" }, "HasLocalMarket": { "type": "boolean", "description": "HasLocalMarket" }, "Rocky": { "type": "boolean", "description": "If planet requires MCG" }, "Gaseous": { "type": "boolean", "description": "If planet requires AEF" }, "LowGravity": { "type": "boolean", "description": "If planet requires MGC" }, "HighGravity": { "type": "boolean", "description": "If planet requires BL" }, "LowPressure": { "type": "boolean", "description": "If planet requires SEA" }, "HighPressure": { "type": "boolean", "description": "If planet requires HSE" }, "LowTemperature": { "type": "boolean", "description": "If planet requires INS" }, "HighTemperature": { "type": "boolean", "description": "If planet requires TSH" }, "Fertile": { "type": "boolean", "description": "If the planet is fertile" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "nullable": true, "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true }, "HasJobData": { "type": "boolean", "description": "If we have job data" }, "TotalPioneers": { "type": "integer", "description": "Total pioneers", "format": "int32", "nullable": true }, "OpenPioneers": { "type": "integer", "description": "Unemployed pioneers", "format": "int32", "nullable": true }, "TotalSettlers": { "type": "integer", "description": "Total settlers", "format": "int32", "nullable": true }, "OpenSettlers": { "type": "integer", "description": "Unemployed settlers", "format": "int32", "nullable": true }, "TotalTechnicians": { "type": "integer", "description": "Total technicians", "format": "int32", "nullable": true }, "OpenTechnicians": { "type": "integer", "description": "Unemployed technicians", "format": "int32", "nullable": true }, "TotalEngineers": { "type": "integer", "description": "Total engineers", "format": "int32", "nullable": true }, "OpenEngineers": { "type": "integer", "description": "Unemployed engineers", "format": "int32", "nullable": true }, "TotalScientists": { "type": "integer", "description": "Total scientists", "format": "int32", "nullable": true }, "OpenScientists": { "type": "integer", "description": "Unemployed scientists", "format": "int32", "nullable": true }, "DistanceResults": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The distance results, in jump distance" } }, "additionalProperties": false, "description": "The result from a /planet/search POST" }, "PlanetSite": { "type": "object", "properties": { "PlanetSiteId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetSiteId" }, "PlanetId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "PlanetId" }, "OwnerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "OwnerId" }, "OwnerName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "OwnerName" }, "OwnerCode": { "maxLength": 16, "minLength": 1, "type": "string", "description": "OwnerCode: CompanyCode if player is active, null if liquidated, naturalId if planetary project", "nullable": true }, "Type": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Type" }, "PlotNumber": { "maximum": 2147483647, "minimum": -1, "type": "integer", "description": "PlotNumber: -1 indicates GhostPlot", "format": "int32" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "GhostPlot": { "type": "boolean", "description": "If this plot is a GhostPlot", "readOnly": true }, "SiteId": { "type": "string", "description": "First 8 characters of PlotId", "readOnly": true } }, "additionalProperties": false, "description": "PlanetSite" }, "PlanetSiteCount": { "type": "object", "properties": { "PlanetId": { "type": "string", "description": "PlanetId" }, "PlanetName": { "type": "string", "description": "PlanetName" }, "PlanetNaturalId": { "type": "string", "description": "PlanetNaturalId" }, "Count": { "type": "integer", "description": "Counter of sites", "format": "int32" } }, "additionalProperties": false, "description": "PlanetSiteCount" }, "PlanetWorkforceFee": { "type": "object", "properties": { "Category": { "maxLength": 19, "minLength": 9, "type": "string", "description": "Category - The building/expertise category" }, "WorkforceLevel": { "maxLength": 10, "minLength": 7, "type": "string", "description": "The tier of worker" }, "Fee": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Fee", "format": "double", "nullable": true }, "Currency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Currency", "nullable": true } }, "additionalProperties": false, "description": "PlanetWorkforceFee" }, "Position": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ProductionLine": { "type": "object", "properties": { "ProductionLineId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ProductionLineId" }, "SiteId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SiteId" }, "LocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocationId" }, "LocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "LocationNaturalId" }, "LocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "LocationName" }, "BuildingName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "BuildingName" }, "BuildingTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "BuildingTicker", "nullable": true }, "Capacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Capacity", "format": "int32" }, "Slots": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Slots - Not sure what this represents", "format": "int32" }, "Efficiency": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Efficiency", "format": "double" }, "Condition": { "maximum": 1, "minimum": 0, "type": "number", "description": "Condition", "format": "double" }, "WorkforceEfficiencies": { "type": "array", "items": { "$ref": "#/components/schemas/WorkforceLevelAndEfficiency" }, "description": "WorkforceEfficiencies", "readOnly": true }, "EfficiencyFactors": { "type": "array", "items": { "$ref": "#/components/schemas/EfficiencyFactor" }, "description": "EfficiencyFactors", "readOnly": true }, "Orders": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionLineOrder" }, "description": "Orders" }, "Timestamp": { "type": "string", "description": "The timestamp of the data", "format": "date-time" } }, "additionalProperties": false, "description": "ProductionLine" }, "ProductionLineListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionLine" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "ProductionLineListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ProductionLineListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "ProductionLineOrder": { "type": "object", "properties": { "ProductionLineOrderId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ProductionLineOrderId" }, "Inputs": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialAndAmount" }, "description": "Inputs", "readOnly": true }, "Outputs": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialAndAmount" }, "description": "Outputs", "readOnly": true }, "Created": { "type": "string", "description": "Created", "format": "date-time" }, "Started": { "type": "string", "description": "Started", "format": "date-time", "nullable": true }, "Completion": { "type": "string", "description": "Completion", "format": "date-time", "nullable": true }, "DurationMs": { "type": "integer", "description": "DurationMs", "format": "int64", "nullable": true }, "LastUpdated": { "type": "string", "description": "LastUpdated", "format": "date-time", "nullable": true }, "CompletionPecentage": { "maximum": 1, "minimum": 0, "type": "number", "description": "CompletionPercentage", "format": "double" }, "Halted": { "type": "boolean", "description": "Halted" }, "FeeCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "FeeCurrencyCode", "nullable": true }, "Fee": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Fee", "format": "double", "nullable": true }, "FeeCollectorId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FeeCollectorId", "nullable": true }, "FeeCollectorName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "FeeCollectorName", "nullable": true }, "FeeCollectorCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "FeeCollectorCode", "nullable": true }, "Recurring": { "type": "boolean", "description": "" } }, "additionalProperties": false, "description": "ProductionLineOrder" }, "ROOT_CHANNEL_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SHARED_CHANNEL_DATA_PAYLOAD" } }, "additionalProperties": false }, "ROOT_CHANNEL_MESSAGE_ADDED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SHARED_MESSAGE_ADDED" } }, "additionalProperties": false }, "ROOT_COMPANY_DATA": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_COMPANY_DATA_PAYLOAD" } }, "additionalProperties": false }, "ROOT_COMPANY_DATA_PAYLOAD": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "code": { "maxLength": 4, "minLength": 1, "type": "string" }, "countryId": { "type": "string" }, "ownCurrency": { "$ref": "#/components/schemas/APEX_COMMON_CURRENCY" }, "currencyAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_CURRENCY_ACCOUNT" } }, "startingProfile": { "maxLength": 20, "minLength": 1, "type": "string" }, "startingLocation": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "ratingReport": { "$ref": "#/components/schemas/ROOT_COMPANY_DATA_RATING_REPORT" }, "headquarters": { "$ref": "#/components/schemas/MESG_COMPANY_DATA_HQ" }, "representation": { "$ref": "#/components/schemas/ROOT_COMPANY_DATA_REPRESENTATION" } }, "additionalProperties": false }, "ROOT_COMPANY_DATA_RATING_REPORT": { "type": "object", "properties": { "overallRating": { "maxLength": 7, "minLength": 1, "type": "string" }, "contractCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "earliestContract": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "ROOT_COMPANY_DATA_REPRESENTATION": { "type": "object", "properties": { "currentLevel": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "costNextLevel": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "contributedNextLevel": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "leftNextLevel": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "contributedTotal": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "contributors": { "type": "array", "items": { } } }, "additionalProperties": false }, "ROOT_PRESENCE_LIST": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_PRESENCE_LIST_PAYLOAD" } }, "additionalProperties": false }, "ROOT_PRESENCE_LIST_PAYLOAD": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRESENCE_LIST_USER" } } }, "additionalProperties": false }, "ROOT_PRESENCE_LIST_USER": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "maxLength": 64, "minLength": 2, "type": "string" }, "time": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ROOT_PRODUCTION_ORDER_ADDED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_ADDED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_PRODUCTION_ORDER_ADDED_PAYLOAD": { "type": "object", "properties": { "id": { "type": "string" }, "productionLineId": { "type": "string" }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" }, "nullable": true }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "started": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completion": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "lastUpdated": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completed": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "halted": { "type": "boolean" }, "productionFee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" }, "recurring": { "type": "boolean" } }, "additionalProperties": false }, "ROOT_PRODUCTION_ORDER_REMOVED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_REMOVED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_PRODUCTION_ORDER_REMOVED_PAYLOAD": { "type": "object", "properties": { "orderId": { "type": "string" }, "productionLineId": { "type": "string" } }, "additionalProperties": false }, "ROOT_PRODUCTION_ORDER_UPDATED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_PRODUCTION_ORDER_UPDATED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_PRODUCTION_ORDER_UPDATED_PAYLOAD": { "type": "object", "properties": { "id": { "type": "string" }, "productionLineId": { "type": "string" }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" }, "nullable": true }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "started": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completion": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "lastUpdated": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completed": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "halted": { "type": "boolean" }, "productionFee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" }, "recurring": { "type": "boolean" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_EFFICIENCY_FACTOR": { "type": "object", "properties": { "expertiseCategory": { "type": "string", "nullable": true }, "type": { "type": "string" }, "effectivity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "value": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_FACTOR": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "factor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_ORDER": { "type": "object", "properties": { "id": { "type": "string" }, "productionLineId": { "type": "string" }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" }, "nullable": true }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "started": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completion": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "lastUpdated": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completed": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "halted": { "type": "boolean" }, "productionFee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" }, "recurring": { "type": "boolean" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_PAYLOAD": { "type": "object", "properties": { "id": { "type": "string" }, "siteId": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "type": { "type": "string" }, "capacity": { "type": "integer", "format": "int32" }, "slots": { "type": "integer", "format": "int32" }, "efficiency": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "condition": { "maximum": 1, "minimum": 0, "type": "number", "format": "double" }, "workforces": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_WORKFORCE" }, "nullable": true }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_ORDER" }, "nullable": true }, "productionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_PRODUCTION_TEMPLATE" }, "nullable": true }, "efficiencyFactors": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_EFFICIENCY_FACTOR" }, "nullable": true } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_PRODUCTION_FEE_FACTOR": { "type": "object", "properties": { "amount": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_PRODUCTION_TEMPLATE": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 2, "type": "string" }, "inputFactors": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_FACTOR" }, "nullable": true }, "outputFactors": { "type": "array", "items": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_FACTOR" }, "nullable": true }, "effortFactor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "efficiency": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "productionFeeFactor": { "$ref": "#/components/schemas/ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_PRODUCTION_FEE_FACTOR" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" } }, "additionalProperties": false }, "ROOT_PRODUCTION_PRODUCTION_LINE_UPDATED_WORKFORCE": { "type": "object", "properties": { "level": { "type": "string" }, "efficiency": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_BUILT": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_BUILT_PAYLOAD" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_BUILT_MODULE": { "type": "object", "properties": { "id": { "type": "string" }, "platformId": { "type": "string" }, "reactorId": { "type": "string" }, "reactorName": { "maxLength": 64, "minLength": 2, "type": "string" }, "reactorTicker": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_BUILT_PAYLOAD": { "type": "object", "properties": { "siteId": { "type": "string" }, "id": { "type": "string" }, "module": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_BUILT_MODULE" }, "area": { "type": "integer", "format": "int32" }, "creationTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "reclaimableMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "repairMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "bookValue": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "condition": { "type": "number", "format": "double" }, "lastRepair": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_REMOVED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_REMOVED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_REMOVED_PAYLOAD": { "type": "object", "properties": { "siteId": { "type": "string" }, "platformId": { "type": "string" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_UPDATED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_UPDATED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_UPDATED_MODULE": { "type": "object", "properties": { "id": { "type": "string" }, "platformId": { "type": "string" }, "reactorId": { "type": "string" }, "reactorName": { "maxLength": 64, "minLength": 2, "type": "string" }, "reactorTicker": { "type": "string" }, "type": { "maxLength": 64, "minLength": 2, "type": "string" } }, "additionalProperties": false }, "ROOT_SITE_PLATFORM_UPDATED_PAYLOAD": { "type": "object", "properties": { "siteId": { "type": "string" }, "id": { "type": "string" }, "module": { "$ref": "#/components/schemas/ROOT_SITE_PLATFORM_UPDATED_MODULE" }, "area": { "type": "integer", "format": "int32" }, "creationTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "reclaimableMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "repairMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "bookValue": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "condition": { "maximum": 1, "minimum": 0.3, "type": "number", "format": "float" }, "lastRepair": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "ROOT_SITE_SITES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SITE_SITES_PAYLOAD_INNER" } }, "additionalProperties": false }, "ROOT_STORAGE_CHANGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_STORAGE_CHANGE_PAYLOAD" } }, "additionalProperties": false }, "ROOT_STORAGE_CHANGE_PAYLOAD": { "type": "object", "properties": { "stores": { "type": "array", "items": { "$ref": "#/components/schemas/STORAGE_STORAGES_STORE" } } }, "additionalProperties": false }, "ROOT_WORKFORCE_WORKFORCES_UPDATED": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/ROOT_WORKFORCE_WORKFORCES_UPDATED_PAYLOAD" } }, "additionalProperties": false }, "ROOT_WORKFORCE_WORKFORCES_UPDATED_PAYLOAD": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "siteId": { "type": "string" }, "workforces": { "type": "array", "items": { "$ref": "#/components/schemas/MESG_WORKFORCE_WORKFORCES_WORKFORCE" } } }, "additionalProperties": false }, "Register": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Username", "example": "Saganaki" }, "Password": { "maxLength": 256, "minLength": 3, "type": "string", "description": "Password", "example": "Hunter2" }, "RegistrationGuid": { "type": "string", "description": "RegistrationGuid", "format": "uuid" } }, "additionalProperties": false, "description": "Payload for registration" }, "RevokeAPIKey": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Username", "example": "Saganaki" }, "Password": { "maxLength": 256, "minLength": 3, "type": "string", "description": "Password", "example": "Hunter2" }, "APIKeyToRevoke": { "type": "string", "description": "APIKeyToRevoke", "format": "uuid" } }, "additionalProperties": false, "description": "RevokeAPIKey Payload" }, "SHARED_CHANNEL_DATA_PAYLOAD": { "type": "object", "properties": { "channelId": { "type": "string" }, "type": { "maxLength": 10, "minLength": 5, "type": "string" }, "naturalId": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "displayName": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "creationTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "lastActivity": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "userCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "maxMessageLength": { "type": "integer", "format": "int32" }, "permissions": { "$ref": "#/components/schemas/SHARED_CHANNEL_DATA_PERMISSIONS" }, "bans": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "SHARED_CHANNEL_DATA_PERMISSIONS": { "type": "object", "properties": { "add": { "type": "boolean" }, "leave": { "type": "boolean" } }, "additionalProperties": false }, "SHARED_MESSAGE_ADDED": { "type": "object", "properties": { "messageId": { "type": "string" }, "type": { "maxLength": 32, "minLength": 2, "type": "string" }, "sender": { "$ref": "#/components/schemas/APEX_COMMON_USER" }, "message": { "maxLength": 1024, "minLength": 0, "type": "string" }, "time": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "channelId": { "type": "string" }, "deletingUser": { "$ref": "#/components/schemas/APEX_COMMON_USER" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_PAYLOAD" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_EFFICIENCY_FACTOR": { "type": "object", "properties": { "expertiseCategory": { "type": "string", "nullable": true }, "type": { "type": "string" }, "effectivity": { "type": "number", "format": "double" }, "value": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_FACTOR": { "type": "object", "properties": { "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "factor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_PAYLOAD_INNER" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_ORDER": { "type": "object", "properties": { "id": { "type": "string" }, "productionLineId": { "type": "string" }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_OUTPUT" }, "nullable": true }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_ORDER_INPUT" } }, "created": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "started": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completion": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "lastUpdated": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "completed": { "type": "number", "format": "double" }, "halted": { "type": "boolean" }, "productionFee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" }, "recurring": { "type": "boolean" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_ORDER_INPUT": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_OUTPUT": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_MESSAGE" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_PAYLOAD_INNER": { "type": "object", "properties": { "siteId": { "type": "string" }, "productionLines": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_PRODUCTION_LINE" } } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_PRODUCTION_LINE": { "type": "object", "properties": { "id": { "type": "string" }, "siteId": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "type": { "type": "string" }, "capacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "slots": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "efficiency": { "maximum": 5, "minimum": 0, "type": "number", "format": "double" }, "condition": { "maximum": 100, "minimum": 0, "type": "number", "format": "double" }, "workforces": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_WORKFORCE" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_ORDER" } }, "productionTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_PRODUCTION_TEMPLATE" } }, "efficiencyFactors": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_EFFICIENCY_FACTOR" } } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_PRODUCTION_TEMPLATE": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "inputFactors": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_FACTOR" } }, "outputFactors": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_PRODUCTION_LINES_FACTOR" } }, "effortFactor": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "efficiency": { "maximum": 5, "minimum": 0, "type": "number", "format": "double" }, "duration": { "$ref": "#/components/schemas/APEX_COMMON_DURATION" }, "productionFeeFactor": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "productionFeeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" } }, "additionalProperties": false }, "SITE_PRODUCTION_LINES_WORKFORCE": { "type": "object", "properties": { "level": { "type": "string" }, "efficiency": { "maximum": 5, "minimum": 0, "type": "number", "format": "double" } }, "additionalProperties": false }, "SITE_SITES_BOOK_VALUE": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "SITE_SITES_OPTION": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string" }, "area": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "expertiseCategory": { "type": "string", "nullable": true }, "needsFertileSoil": { "type": "boolean" }, "type": { "maxLength": 32, "minLength": 0, "type": "string" }, "workforceCapacities": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_SITES_WORKFORCE_CAPACITY" } }, "materials": { "$ref": "#/components/schemas/SITE_SITES_OPTION_MATERIALS" } }, "additionalProperties": false }, "SITE_SITES_OPTIONS": { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_SITES_OPTION" } } }, "additionalProperties": false }, "SITE_SITES_OPTION_MATERIALS": { "type": "object", "properties": { "quantities": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } } }, "additionalProperties": false }, "SITE_SITES_PAYLOAD_INNER": { "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_SITES_SITE" } } }, "additionalProperties": false }, "SITE_SITES_PLATFORM": { "type": "object", "properties": { "siteId": { "type": "string" }, "id": { "type": "string" }, "module": { "$ref": "#/components/schemas/SITE_SITES_PLATFORM_MODULE" }, "area": { "type": "integer", "format": "int32" }, "creationTime": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "reclaimableMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "repairMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL_AND_AMOUNT" } }, "bookValue": { "$ref": "#/components/schemas/SITE_SITES_BOOK_VALUE" }, "condition": { "maximum": 1, "minimum": 0, "type": "number", "format": "float" }, "lastRepair": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" } }, "additionalProperties": false }, "SITE_SITES_PLATFORM_MODULE": { "type": "object", "properties": { "id": { "type": "string" }, "platformId": { "type": "string" }, "reactorId": { "type": "string" }, "reactorName": { "maxLength": 64, "minLength": 3, "type": "string" }, "reactorTicker": { "type": "string" }, "type": { "maxLength": 64, "minLength": 3, "type": "string" } }, "additionalProperties": false }, "SITE_SITES_SITE": { "type": "object", "properties": { "siteId": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "founded": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SITE_SITES_PLATFORM" } }, "buildOptions": { "$ref": "#/components/schemas/SITE_SITES_OPTIONS" }, "area": { "type": "integer", "format": "int32" }, "investedPermits": { "type": "integer", "format": "int32" }, "maximumPermits": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SITE_SITES_WORKFORCE_CAPACITY": { "type": "object", "properties": { "level": { "type": "string" }, "capacity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "STORAGE_STORAGES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/STORAGE_STORAGES_PAYLOAD" } }, "additionalProperties": false }, "STORAGE_STORAGES_AMOUNT_AND_CURRENCY": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" } }, "additionalProperties": false }, "STORAGE_STORAGES_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/STORAGE_STORAGES_PAYLOAD_INNER" } }, "additionalProperties": false }, "STORAGE_STORAGES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/STORAGE_STORAGES_MESSAGE" } }, "additionalProperties": false }, "STORAGE_STORAGES_PAYLOAD_INNER": { "type": "object", "properties": { "stores": { "type": "array", "items": { "$ref": "#/components/schemas/STORAGE_STORAGES_STORE" } } }, "additionalProperties": false }, "STORAGE_STORAGES_STORE": { "type": "object", "properties": { "id": { "type": "string" }, "addressableId": { "type": "string" }, "name": { "maxLength": 64, "minLength": 3, "type": "string", "nullable": true }, "weightLoad": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "weightCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "volumeLoad": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "volumeCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "format": "double" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/STORAGE_STORAGES_STORE_ITEM" } }, "fixed": { "type": "boolean" }, "tradeStore": { "type": "boolean" }, "rank": { "type": "integer", "format": "int32" }, "locked": { "type": "boolean" }, "type": { "type": "string" } }, "additionalProperties": false }, "STORAGE_STORAGES_STORE_ITEM": { "type": "object", "properties": { "quantity": { "$ref": "#/components/schemas/STORAGE_STORAGES_STORE_QUANTITY" }, "id": { "type": "string" }, "type": { "type": "string" }, "weight": { "type": "number", "format": "double" }, "volume": { "type": "number", "format": "double" } }, "additionalProperties": false }, "STORAGE_STORAGES_STORE_QUANTITY": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/STORAGE_STORAGES_AMOUNT_AND_CURRENCY" }, "material": { "$ref": "#/components/schemas/APEX_COMMON_MATERIAL" }, "amount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SYSTEM_STARS": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SYSTEM_STARS_PAYLOAD" } }, "additionalProperties": false }, "SYSTEM_STARS_MESSAGE": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/SYSTEM_STARS_PAYLOAD_INNER" } }, "additionalProperties": false }, "SYSTEM_STARS_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/SYSTEM_STARS_MESSAGE" } }, "additionalProperties": false }, "SYSTEM_STARS_PAYLOAD_INNER": { "type": "object", "properties": { "stars": { "type": "array", "items": { "$ref": "#/components/schemas/SYSTEM_STARS_STAR" } } }, "additionalProperties": false }, "SYSTEM_STARS_STAR": { "type": "object", "properties": { "systemId": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" }, "name": { "type": "string" }, "type": { "maxLength": 1, "minLength": 1, "type": "string" }, "position": { "$ref": "#/components/schemas/Position" }, "sectorId": { "maxLength": 10, "minLength": 8, "type": "string" }, "subSectorId": { "maxLength": 20, "minLength": 13, "type": "string" }, "connections": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Sector": { "type": "object", "properties": { "SectorId": { "maxLength": 10, "minLength": 8, "type": "string", "description": "SectorId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "HexQ": { "type": "integer", "description": "HexQ", "format": "int32" }, "HexR": { "type": "integer", "description": "HexR", "format": "int32" }, "HexS": { "type": "integer", "description": "HexS", "format": "int32" }, "Size": { "type": "integer", "description": "Size", "format": "int32" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "SubSectors": { "type": "array", "items": { "$ref": "#/components/schemas/SubSector" }, "description": "SubSectors" } }, "additionalProperties": false, "description": "Sector" }, "SetAllowAnonymousDataCollection": { "type": "object", "properties": { "AllowAnonymousDataCollection": { "type": "boolean" } }, "additionalProperties": false }, "SetDiscord": { "type": "object", "properties": { "DiscordName": { "maxLength": 32, "minLength": 0, "type": "string", "description": "DiscordName" } }, "additionalProperties": false, "description": "SetDiscord" }, "SetWebhook": { "type": "object", "properties": { "WebHookUrl": { "maxLength": 256, "minLength": 3, "type": "string", "description": "WebHookUrl" } }, "additionalProperties": false, "description": "SetWebhook" }, "Ship": { "type": "object", "properties": { "ShipId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ShipId" }, "StoreId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "StoreId (Cargo)" }, "STLFuelStoreId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "STLFuelStoreId" }, "FTLFuelStoreId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FTLFuelStoreId" }, "Registration": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Registration" }, "Name": { "maxLength": 32, "minLength": 0, "type": "string", "description": "Name", "nullable": true }, "CommisioningTime": { "type": "string", "description": "CommisioningTime", "format": "date-time" }, "BlueprintNaturalId": { "maxLength": 20, "minLength": 1, "type": "string", "description": "BlueprintNaturalId" }, "CurrentLocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "CurrentLocationId", "nullable": true }, "CurrentLocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "CurrentLocationName", "nullable": true }, "CurrentLocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "CurrentLocationNaturalId", "nullable": true }, "FlightId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "FlightId", "nullable": true }, "Acceleration": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Acceleration", "format": "double" }, "Thrust": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Thrust", "format": "double" }, "Mass": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Mass", "format": "double" }, "OperatingEmptyMass": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "OperatingEmptyMass", "format": "double" }, "Volume": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "Volume", "format": "double" }, "ReactorPower": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "ReactorPower", "format": "double", "nullable": true }, "EmitterPower": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "EmitterPower", "format": "double" }, "STLFuelFlowRate": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "STLFuelFlowRate", "format": "double" }, "OperatingTimeSTLMilliseconds": { "type": "integer", "description": "OperatingTimeSTL", "format": "int64" }, "OperatingTimeFTLMilliseconds": { "type": "integer", "description": "OperatingTimeFTLMilliseconds", "format": "int64" }, "Condition": { "maximum": 1, "minimum": 0, "type": "number", "description": "Condition", "format": "double" }, "LastRepair": { "type": "string", "description": "LastRepair", "format": "date-time", "nullable": true }, "RepairMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/ShipRepairMaterial" }, "description": "RepairMaterials" }, "Timestamp": { "type": "string", "description": "The timestamp of the data", "format": "date-time" } }, "additionalProperties": false, "description": "Ship" }, "ShipListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Ship" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "ShipListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ShipListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "ShipPermissions": { "type": "object", "properties": { "Information": { "type": "boolean", "description": "Information such as Ship name, registration, specs (acceleration, mass, etc)", "default": true }, "Repair": { "type": "boolean", "description": "Information such as ship condition, last repair, and materials needed to repair", "default": true }, "Flight": { "type": "boolean", "description": "Ship flight information", "default": true }, "Inventory": { "type": "boolean", "description": "Ship Inventory", "default": true }, "FuelInventory": { "type": "boolean", "description": "Ship fuel inventory", "default": true } }, "additionalProperties": false, "description": "Ship Permissions" }, "ShipRepairMaterial": { "type": "object", "properties": { "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialId" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "Amount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Amount", "format": "int32" } }, "additionalProperties": false, "description": "ShipRepairMaterial" }, "SimulationData": { "type": "object", "properties": { "SimulationInterval": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "How fast the game simulations", "format": "int32" }, "FlightSTLFactor": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "How fast ships fly through STL space", "format": "int32" }, "FlightFTLFactor": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "How fast ships fly through FTL space", "format": "int32" }, "PlanetaryMotionFactor": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "How fast planets move", "format": "int32" }, "ParsecLength": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "How long a single parsec is", "format": "int32" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "Global Simulation Data" }, "Site": { "type": "object", "properties": { "SiteId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SiteId" }, "LocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocationId" }, "LocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "LocationNaturalId" }, "LocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "LocationName" }, "Founded": { "type": "string", "description": "Founded", "format": "date-time" }, "Area": { "type": "integer", "description": "Area", "format": "int32" }, "InvestedPermits": { "type": "integer", "description": "InvestedPermits", "format": "int32" }, "MaximumPermits": { "type": "integer", "description": "MaximumPermits", "format": "int32" }, "Buildings": { "type": "array", "items": { "$ref": "#/components/schemas/SiteBuilding" }, "description": "Platforms" }, "Timestamp": { "type": "string", "description": "The timestamp of the data", "format": "date-time" } }, "additionalProperties": false, "description": "Sites" }, "SiteBuilding": { "type": "object", "properties": { "SiteBuildingId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SiteBuildingId (PlatformId)" }, "Area": { "type": "integer", "description": "Area", "format": "int32" }, "CreationTime": { "type": "string", "description": "CreationTime", "format": "date-time" }, "BuildingName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "BuildingName" }, "BuildingTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "BuildingTicker" }, "BuildingType": { "maxLength": 20, "minLength": 4, "type": "string", "description": "BuildingType" }, "BookValueCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "BookValueCurrencyCode" }, "BookValueAmount": { "type": "number", "description": "BookValueAmount", "format": "double" }, "Condition": { "maximum": 1, "minimum": 0, "type": "number", "description": "Condition", "format": "double" }, "LastRepair": { "type": "string", "description": "LastRepair", "format": "date-time", "nullable": true }, "ReclaimableMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialTickerAndAmount" }, "description": "ReclaimableMaterials", "readOnly": true }, "RepairMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialTickerAndAmount" }, "description": "RepairMaterials", "readOnly": true }, "SiteId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SiteId" } }, "additionalProperties": false, "description": "SiteBuilding" }, "SiteListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Site" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "SiteListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SiteListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "SitePermissions": { "type": "object", "properties": { "Location": { "type": "boolean", "description": "Where your sites are located", "default": true }, "Workforces": { "type": "boolean", "description": "Workforce data (worker counts and capacity)", "default": true }, "Experts": { "type": "boolean", "description": "Experts", "default": true }, "Buildings": { "type": "boolean", "description": "The general building information (effectively, building ticker)", "default": true }, "Repair": { "type": "boolean", "description": "Repair costs", "default": true }, "Reclaimable": { "type": "boolean", "description": "Reclaimables", "default": true }, "ProductionLines": { "type": "boolean", "description": "Production line information. This includes all active and pending orders", "default": true } }, "additionalProperties": false, "description": "Site Permissions" }, "Star": { "type": "object", "properties": { "StarId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "StarId" }, "SystemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SystemId" }, "SystemNaturalId": { "maxLength": 6, "minLength": 6, "type": "string", "description": "SystemNaturalId" }, "SystemName": { "maxLength": 64, "minLength": 0, "type": "string", "description": "SystemName", "nullable": true }, "SectorId": { "maxLength": 10, "minLength": 8, "type": "string", "description": "SectorId" }, "SubSectorId": { "maxLength": 20, "minLength": 13, "type": "string", "description": "SubSectorId" }, "Type": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Type" }, "Luminosity": { "type": "number", "description": "Luminosity", "format": "double" }, "Mass": { "type": "number", "description": "Mass", "format": "double" }, "MassSol": { "type": "number", "description": "MassSol", "format": "double" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "Star" }, "Station": { "type": "object", "properties": { "StationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "StationId" }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Station name" }, "CurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Currency Code" }, "CountryId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Country Id" }, "CountryCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Country code" }, "CountryName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Country name" }, "GoverningEntityId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Governing entity id" }, "GoverningEntityCode": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Governing entity code" }, "GoverningEntityName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Governing entity name" }, "WarehouseId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Warehouse Id", "nullable": true }, "LocalMarketId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocalMarketId", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "nullable": true, "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityFriendlyIdentifier", "readOnly": true } }, "additionalProperties": false, "description": "Station" }, "Storage": { "type": "object", "properties": { "StorageId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "StorageId" }, "AddressableId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "AddressableId" }, "SiteId": { "type": "string", "description": "SiteId", "readOnly": true }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "LocationId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "LocationId", "nullable": true }, "LocationNaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "LocationNaturalId", "nullable": true }, "LocationName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "LocationName", "nullable": true }, "WeightLoad": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "WeightLoad", "format": "double" }, "WeightCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "WeightCapacity", "format": "double" }, "VolumeLoad": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "VolumeLoad", "format": "double" }, "VolumeCapacity": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "VolumeCapacity", "format": "double" }, "Fixed": { "type": "boolean", "description": "Fixed - If it's a fixed/stationary store" }, "TradeStore": { "type": "boolean", "description": "TradeStore - If you can trade from it. Only fuel tanks cannot." }, "Rank": { "type": "integer", "description": "Rank - Usage not yet known", "format": "int32" }, "Locked": { "type": "boolean", "description": "Locked - If the store is locked (warehouse not payed)" }, "Type": { "maxLength": 17, "minLength": 5, "type": "string", "description": "Type - STORE, WAREHOUSE_STORE, STL_FUEL_STORE, FTL_FUEL_STORE, VORTEX_FUEL_STORE" }, "StorageItems": { "type": "array", "items": { "$ref": "#/components/schemas/StorageItem" }, "description": "StorageItems" }, "Timestamp": { "type": "string", "description": "The timestamp of the data", "format": "date-time" } }, "additionalProperties": false, "description": "Storage" }, "StorageItem": { "type": "object", "properties": { "ItemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "ItemId" }, "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialId", "nullable": true }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker", "nullable": true }, "Amount": { "type": "integer", "description": "Amount", "format": "int32", "nullable": true }, "Weight": { "type": "number", "description": "Weight", "format": "double" }, "Volume": { "type": "number", "description": "Volume", "format": "double" }, "Type": { "maxLength": 32, "minLength": 3, "type": "string", "description": "Type" }, "ValueCurrencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ValueCurrencyCode", "nullable": true }, "Value": { "type": "number", "description": "Value", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "StorageItem" }, "StorageListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Storage" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "StorageListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/StorageListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "StoragePermissions": { "type": "object", "properties": { "Location": { "type": "boolean", "description": "The location of all your storage (inventory and warehouse)", "default": true }, "Information": { "type": "boolean", "description": "Information about the storage (Weight/Volume capacity, warehouse or base storage, etc)", "default": true }, "Items": { "type": "boolean", "description": "Inventory items. This also implies actual weight/volume permissions", "default": true } }, "additionalProperties": false, "description": "Storage permissions" }, "SubSector": { "type": "object", "properties": { "SubSectorId": { "maxLength": 20, "minLength": 13, "type": "string", "description": "SubSectorId" }, "Vertices": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } }, "description": "Helper to retrieve the vertices", "readOnly": true } }, "additionalProperties": false, "description": "SubSector" }, "System": { "type": "object", "properties": { "SystemId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SystemId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "Nameable": { "type": "boolean", "description": "Nameable" }, "NamerId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "NamerId", "nullable": true }, "NamerUserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "NamerUserName", "nullable": true }, "NaturalId": { "maxLength": 6, "minLength": 6, "type": "string", "description": "NaturalId" }, "Type": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Type" }, "SectorId": { "maxLength": 10, "minLength": 8, "type": "string", "description": "SectorId" }, "SubSectorId": { "maxLength": 20, "minLength": 13, "type": "string", "description": "SubSectorId" }, "PositionX": { "type": "number", "description": "PositionX", "format": "double" }, "PositionY": { "type": "number", "description": "PositionY", "format": "double" }, "PositionZ": { "type": "number", "description": "PositionZ", "format": "double" }, "MeteroidDensity": { "type": "number", "description": "MeteroidDensity", "format": "double", "nullable": true }, "Connections": { "type": "array", "items": { "type": "string" }, "description": "List of connections" }, "PlanetIds": { "type": "array", "items": { "type": "string" }, "description": "List of PlanetIds" }, "CelestialBodyIds": { "type": "array", "items": { "type": "string" }, "description": "List of CelestialBodyIds (stations)" }, "CelestialBodies": { "type": "array", "items": { "$ref": "#/components/schemas/SystemCelestialBody" }, "description": "CelestialBodies" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "EntityId": { "type": "string", "description": "EntityId", "readOnly": true }, "EntityName": { "type": "string", "description": "EntityName", "nullable": true, "readOnly": true }, "EntityFriendlyIdentifier": { "type": "string", "description": "EntityNaturalId", "readOnly": true } }, "additionalProperties": false, "description": "System" }, "SystemCelestialBody": { "type": "object", "properties": { "SystemCelestialBodyId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "SystemCelestialBodyId" }, "Name": { "maxLength": 64, "minLength": 2, "type": "string", "description": "Name", "nullable": true }, "NaturalId": { "maxLength": 16, "minLength": 3, "type": "string", "description": "NaturalId" }, "Type": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Type" }, "SemiMajorAxis": { "type": "number", "description": "SemiMajorAxis", "format": "double" }, "Eccentricity": { "type": "number", "description": "Eccentricity", "format": "double" }, "Inclination": { "type": "number", "description": "Inclination", "format": "double" }, "RightAscension": { "type": "number", "description": "RightAscension", "format": "double" }, "Periapsis": { "type": "number", "description": "Periapsis", "format": "double" } }, "additionalProperties": false, "description": "SystemCelestialBody" }, "TradePermissions": { "type": "object", "properties": { "Contract": { "type": "boolean", "description": "Contract information", "default": true }, "CXOS": { "type": "boolean", "description": "CXOS information", "default": true } }, "additionalProperties": false, "description": "Trade permissions" }, "User": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "UserName" }, "DisplayUserName": { "maxLength": 32, "minLength": 2, "type": "string", "description": "DisplayUserName" }, "PasswordHash": { "maxLength": 128, "minLength": 0, "type": "string", "description": "PasswordHash" }, "IsAdmin": { "type": "boolean", "description": "IsAdmin", "default": false }, "IsBot": { "type": "boolean", "description": "IsBot", "readOnly": true }, "DiscordName": { "maxLength": 32, "minLength": 0, "type": "string", "description": "DiscordId", "default": "" }, "WebhookCallbackUrl": { "maxLength": 256, "minLength": 0, "type": "string", "description": "WebhookCallbackUrl", "nullable": true }, "AllowAnonymousDataCollection": { "type": "boolean", "description": "AllowAnonymousDataCollection" } }, "additionalProperties": false, "description": "UserModel" }, "UserInvite": { "type": "object", "properties": { "UserName": { "maxLength": 32, "minLength": 3, "type": "string", "description": "The username of the person being invited" }, "Admin": { "type": "boolean", "description": "If this is an invite for an admin role" } }, "additionalProperties": false, "description": "UserInvite" }, "WAREHOUSE_STORAGES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES_PAYLOAD" } }, "additionalProperties": false }, "WAREHOUSE_STORAGES_INNER_PAYLOAD": { "type": "object", "properties": { "storages": { "type": "array", "items": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES_STORAGE" } } }, "additionalProperties": false }, "WAREHOUSE_STORAGES_MESSAGES": { "type": "object", "properties": { "messageType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES_INNER_PAYLOAD" } }, "additionalProperties": false }, "WAREHOUSE_STORAGES_PAYLOAD": { "type": "object", "properties": { "actionId": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "$ref": "#/components/schemas/WAREHOUSE_STORAGES_MESSAGES" } }, "additionalProperties": false }, "WAREHOUSE_STORAGES_STORAGE": { "type": "object", "properties": { "warehouseId": { "type": "string" }, "storeId": { "type": "string" }, "units": { "type": "integer", "format": "int32" }, "weightCapacity": { "type": "number", "format": "double" }, "volumeCapacity": { "type": "number", "format": "double" }, "nextPayment": { "$ref": "#/components/schemas/APEX_COMMON_TIMESTAMP" }, "fee": { "$ref": "#/components/schemas/APEX_COMMON_AMOUNT_AND_CURRENCY" }, "feeCollector": { "$ref": "#/components/schemas/APEX_COMMON_USER_AND_CODE_NULLABLE" }, "status": { "type": "string" }, "address": { "$ref": "#/components/schemas/APEX_COMMON_ADDRESS" } }, "additionalProperties": false }, "Workforce": { "type": "object", "properties": { "SiteId": { "type": "string", "description": "SiteId", "readOnly": true }, "PioneerPopulation": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "PioneerPopulation", "format": "int32" }, "PioneerReserve": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "PioneerReserve", "format": "int32" }, "PioneerCapacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "PioneerCapacity", "format": "int32" }, "PioneerRequired": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "PioneerRequired", "format": "int32" }, "PioneerSatisfaction": { "maximum": 1, "minimum": 0, "type": "number", "description": "PioneerSatisfaction", "format": "double" }, "SettlerPopulation": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "SettlerPopulation", "format": "int32" }, "SettlerReserve": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "SettlerReserve", "format": "int32" }, "SettlerCapacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "SettlerCapacity", "format": "int32" }, "SettlerRequired": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "SettlerRequired", "format": "int32" }, "SettlerSatisfaction": { "maximum": 1, "minimum": 0, "type": "number", "description": "SettlerSatisfaction", "format": "double" }, "TechnicianPopulation": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "TechnicianPopulation", "format": "int32" }, "TechnicianReserve": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "TechnicianReserve", "format": "int32" }, "TechnicianCapacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "TechnicianCapacity", "format": "int32" }, "TechnicianRequired": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "TechnicianRequired", "format": "int32" }, "TechnicianSatisfaction": { "maximum": 1, "minimum": 0, "type": "number", "description": "TechnicianSatisfaction", "format": "double" }, "EngineerPopulation": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "EngineerPopulation", "format": "int32" }, "EngineerReserve": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "EngineerReserve", "format": "int32" }, "EngineerCapacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "EngineerCapacity", "format": "int32" }, "EngineerRequired": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "EngineerRequired", "format": "int32" }, "EngineerSatisfaction": { "maximum": 1, "minimum": 0, "type": "number", "description": "EngineerSatisfaction", "format": "double" }, "ScientistPopulation": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "ScientistPopulation", "format": "int32" }, "ScientistReserve": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "ScientistReserve", "format": "int32" }, "ScientistCapacity": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "ScientistCapacity", "format": "int32" }, "ScientistRequired": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "ScientistRequired", "format": "int32" }, "ScientistSatisfaction": { "maximum": 1, "minimum": 0, "type": "number", "description": "ScientistSatisfaction", "format": "double" }, "LastTickTime": { "type": "string", "description": "LastTickTime - When consumables were last pulled from this site", "format": "date-time", "nullable": true }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" }, "WorkforceNeeds": { "type": "array", "items": { "$ref": "#/components/schemas/WorkforceNeed" }, "description": "WorkforceNeeds" } }, "additionalProperties": false, "description": "Workforce" }, "WorkforceLevelAndEfficiency": { "type": "object", "properties": { "Level": { "type": "string", "description": "Level" }, "Efficiency": { "maximum": 5, "minimum": 0, "type": "number", "description": "Efficiency", "format": "double" } }, "additionalProperties": false, "description": "WorkforceLevelAndEfficiency" }, "WorkforceListIndividualUserResponse": { "title": "IndividualUserResponse>", "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" }, "description": "Any errors with the associated username" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/Workforce" }, "description": "The data" } }, "additionalProperties": false, "description": "An individual response" }, "WorkforceListRetrievalResponse": { "title": "RetrievalResponse>", "type": "object", "properties": { "UserNameToData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/WorkforceListIndividualUserResponse" }, "description": "All responses" } }, "additionalProperties": false, "description": "A grouped response" }, "WorkforceNeed": { "type": "object", "properties": { "Level": { "maxLength": 10, "minLength": 7, "type": "string", "description": "Level" }, "Category": { "maxLength": 8, "minLength": 4, "type": "string", "description": "Category" }, "Essential": { "type": "boolean", "description": "Essential" }, "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "MaterialId" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "MaterialTicker" }, "MaterialName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "MaterialName" }, "Satisfaction": { "maximum": 1, "minimum": 0, "type": "number", "description": "Satisfaction", "format": "double" }, "UnitsPerInterval": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "UnitsPerInterval", "format": "double" }, "UnitsPer100": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "UnitsPer100", "format": "double" } }, "additionalProperties": false, "description": "WorkforceNeed" }, "WorkforceRequirement": { "type": "object", "properties": { "Level": { "maxLength": 10, "minLength": 7, "type": "string", "description": "The \"level\" or name of the workforce tier (PIONEER, SETTLER, etc)" }, "Needs": { "type": "array", "items": { "$ref": "#/components/schemas/WorkforceRequirementNeed" }, "description": "The workforce needs for this tier of workers" }, "Timestamp": { "type": "string", "description": "Timestamp", "format": "date-time" } }, "additionalProperties": false, "description": "WorkforceRequirement" }, "WorkforceRequirementNeed": { "type": "object", "properties": { "Essential": { "type": "boolean", "description": "If the need is essential" }, "MaterialName": { "maxLength": 64, "minLength": 2, "type": "string", "description": "The name of the material" }, "MaterialTicker": { "maxLength": 4, "minLength": 1, "type": "string", "description": "The need's ticker" }, "MaterialId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "The material id" }, "UnitsPer100": { "maximum": 1.7976931348623157E+308, "minimum": 0, "type": "number", "description": "The amount consumed per 100 workers", "format": "double" } }, "additionalProperties": false, "description": "WorkforceRequirementNeed" } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Authorization header using Bearer scheme. Example:

`Authorization: Bearer {token}`

**NOTE:** When authenticating through the documentation page, do not include 'Bearer'.", "scheme": "bearer", "bearerFormat": "JWT" }, "FIOAPIKey": { "type": "apiKey", "description": "Authorization header using FIOAPIKey scheme.
Example:

`Authorization: FIOAPIKey {APIKey}`

**NOTE:** When authenticating through the documentation page, make sure the input is `FIOAPIKey {Key}`.", "name": "Authorization", "in": "header" } } }, "tags": [ { "name": "Admin" }, { "name": "APEXUser" }, { "name": "Auth" }, { "name": "Building" }, { "name": "Chat" }, { "name": "Company" }, { "name": "Contracts" }, { "name": "CSV" }, { "name": "CX" }, { "name": "Data" }, { "name": "FX" }, { "name": "Gateway" }, { "name": "Global" }, { "name": "Group" }, { "name": "Infrastructure" }, { "name": "LocalMarket" }, { "name": "Map" }, { "name": "Material" }, { "name": "Permission" }, { "name": "Planet" }, { "name": "ProductionLine" }, { "name": "Ships" }, { "name": "Sites" }, { "name": "Storage" } ] }