{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7b8cbe3f-232c-4a57-833a-bd87b506f1c4","name":"NOVA AVA","description":"## Introduction\n\nThis documentation assumes a basic knowledge of how REST APIs work. Visit [this link](https://www.restapitutorial.com/) if you need an introduction to this topic.\n\nIn case you have any questions or feedback, we would love to hear from you. Email us at [support@avanova.de](https://mailto:support@avanova.de).\n\n## Connection\n\n**Connect via base URL** `https://api.avanova.de/v1`  \nIf you are using the base URL to connect to the API, you need to sent the HTTP header `TENANT` with your account permalink. The permalink is the subdomain part of your account URL `[TENANT].avanova.de`.\n\n**Connect via account URL** `https://[TENANT].avanova.de/api.php`  \nAlternatively you can connect directly to your account without the need of sending the `TENANT` header.\n\n## Auth\n\nTo authenticate you need to send an `Bearer Token` in HTTP header with each HTTP request.\n\nThe needed `Token` must be obtained from the [Token Endpoint](https://documenter.getpostman.com/view/16460278/UzJJtc4t#0dd9dc4c-676f-4f0a-817e-5f3f8a53c0af) via OAuth2 Client Credentials.\n\nYou will receive an `Access Token` and a `Refresh Token`. Each HTTP request needs to be authorized with the `Access Token`. If the access token is expired, you can obtain a new `Access Token` with the `Refresh Token`.\n\n## Limitations\n\nRequests are limited to:\n\n- **60 per minute** in _STARTER_ package\n    \n- **200 per minute** in _EASY_ package\n    \n- **600 per minute** in _BUSINESS_ package\n    \n\nIf the limit is exceeded, you will receive the HTTP error: `429 Too many requests`\n\nAll result lists are limited to 100 by default. This limit can be increased by the query parameter `limit` to a maximum of 1000.\n\n## Pagination\n\nTo paginate through list responses the `page` query parameter is used. Also every list will return a `_list` array which includes `next` and `prev` links to navigate directly to the corresponding page. If one or both of these entries are not available, there is no other page available.\n\n## Query filter\n\nMany list resources can be filtered. In `/addresses` you can filter e.g. by name with `/addresses?name1=Example`. If you want to filter multiple names, you can either enter them separated by commas `/addresses?name1=Example,Max` or as an array `/addresses?name1[]=Example&name1[]=Max`.\n\n**Warning**: The maximum size of an HTTP request line in bytes is 4094. If this limit is exceeded, you will receive the HTTP error: `414 Request-URI too large`\n\n## HTML fields\n\nFields containing HTML can be converted to plain text. Use the request parameter `htmlAsPlain=true` with you request uri to return HTML fields as plain text.\n\n## Date and DateTime format\n\n- **date** = _Y-m-d_ = `2016-12-31`\n    \n- **datetime** = _Y-m-d H:i:s_ = `2016-12-31 03:13:37`\n    \n\n## Miscellaneous\n\nID fields, date or datetime fields can be `null` because the attributes have been added later and the entry is older.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16460278","team":2137222,"collectionId":"7b8cbe3f-232c-4a57-833a-bd87b506f1c4","publishedId":"UzJJtc4t","public":true,"publicUrl":"https://documenter-api.postman.tech/view/16460278/UzJJtc4t","privateUrl":"https://go.postman.co/documentation/16460278-7b8cbe3f-232c-4a57-833a-bd87b506f1c4","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"34495e"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-06T13:24:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"NOVA AVA","id":"7b454158-72eb-472c-860a-475493ca1765","owner":"16460278","values":[{"key":"NovaURL","value":"https://api.avanova.de","enabled":true},{"key":"Tenant","value":"","enabled":true},{"key":"ClientID","value":"","enabled":true,"type":"default"},{"key":"ClientSecret","value":"","enabled":true,"type":"default"},{"key":"BearerToken","value":"","enabled":true},{"key":"UserID","value":"","enabled":true},{"key":"UserName","value":"","enabled":true},{"key":"UserEmail","value":"","enabled":true},{"key":"UserPassword","value":"","enabled":true},{"key":"AddressID","value":"","enabled":true},{"key":"AddressCompany","value":"","enabled":true},{"key":"AddressContact","value":"","enabled":true},{"key":"AddressEmail","value":"","enabled":true},{"key":"ProjectID","value":"","enabled":true},{"key":"ProjectKey","value":"","enabled":true},{"key":"ProjectName","value":"","enabled":true},{"key":"ProjectAddressID","value":"","enabled":true},{"key":"ProjectAddressCompany","value":"","enabled":true},{"key":"BuildingID","value":"","enabled":true},{"key":"BuildingName","value":"","enabled":true},{"key":"BuildingDescription","value":"","enabled":true},{"key":"BuildingOnlyBaseQuantities","value":"0","enabled":true},{"key":"BuildingPipeline","value":"default","enabled":true},{"key":"BuildingNodeID","value":"","enabled":true},{"key":"EstimateID","value":"","enabled":true},{"key":"EstimateNodeID","value":"","enabled":true},{"key":"BoqID","value":"","enabled":true},{"key":"BoqNodeID","value":"","enabled":true},{"key":"BoqTypeID","value":"","enabled":true},{"key":"BoqBidderID","value":"","enabled":true},{"key":"BoqSheetID","value":"","enabled":true,"type":"default"},{"key":"BoqInvoiceID","value":"","enabled":true},{"key":"BoqAddressID","value":"","enabled":true},{"key":"CatalogID","value":"","enabled":true},{"key":"CatalogName","value":"","enabled":true},{"key":"CatalogType","value":"","enabled":true},{"key":"CatalogNodeID","value":"","enabled":true},{"key":"DocumentID","value":"","enabled":true,"type":"default"},{"key":"UserGroupID","value":"","enabled":true,"type":"default"},{"key":"UserGroupName","value":"","enabled":true,"type":"default"},{"key":"UserGroupUsers","value":"","enabled":true,"type":"default"},{"key":"CostKeyGroupID","value":"1","enabled":true,"type":"default"},{"key":"CalculationID","value":"","enabled":true,"type":"default","description":""},{"key":"AnalysisID","value":"","enabled":true,"type":"default","description":""},{"key":"AnalysisNodeID","value":"","enabled":true,"type":"default","description":""}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/ddc60859b45f5dc5e56c3523903c348433dab908783775ebd3c2590315fb8c6e","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"NOVA AVA","value":"16460278-7b454158-72eb-472c-860a-475493ca1765"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UzJJtc4t"}