{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c6ac84eb-144c-4527-99ed-277cd60be39f","name":"API Vertown","description":"A API da Vertown segue o padrão [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Todas as respostas são retornadas em [JSON](https://www.json.org) e utiliza códigos de resposta, autenticação e verbos HTTP padrão.\n\n# Erros\n\nA API usa códigos de resposta HTTP convencionais para indicar o sucesso ou falha de uma solicitação de API.\n\n| Código | Erro | O que significa |\n| --- | --- | --- |\n| 200 | OK | Tudo funcionou como esperado |\n| 400 | Bad Request | A solicitação foi inaceitável, geralmente devido à falta de um parâmetro necessário |\n| 401 | Unauthorized | Autenticação inválida ou token de autenticação não enviado |\n| 403 | Forbidden | O token enviado não possui permissões para executar a solicitação |\n| 404 | Not found | Recurso solicitado não existe |\n| 500 | Server Error | Erro inesperado no servidor. (estes são erros raros) |\n\nErros `400` que envolvem algum parâmetro incorreto retornam mensagens de erro com códigos de erro específicos para cada situação em um array de mensagens seguindo o seguinte formato:\n\nEx:\n\n`[ { Code = \"001\", Message = \"Name field is mandatory\" }, ... ]`\n\n# Dados da organização\n\nNa Vertown a sua organização é dividida em: organização, unidade da organização e áreas geradoras.\n\nSempre que a API exigir o parâmetro **Organization** via header, deve-se enviar o seu **organizationId**, ou seja, o código da sua organização. Este código é unico para todas unidades.\n\nSempre que a API exigir o parâmetro **OrganizationUnitId**, deve-se enviar o código da unidade associada à ação sendo requisitada.\n\n# Unidade de medida\n\nAs unidades de medida possuem códigos fixos no banco de dados. Sempre que alguma API solicitar **measureUnitId** utilize os códigos de acordo com a seguinte tabela:\n\n| Código | Unidade de medida |\n| --- | --- |\n| 106 | Métro Cúbico (M³) |\n| 107 | Litro (L) |\n| 108 | Quilograma (Kg) |\n| 109 | Tonelada (Ton) |\n| 110 | Unidade (Und) |\n\n# Paginação\n\nAlguns recursos da API possuem listagem paginada e recebem dois parâmetros: _\\*skip e take_.\n\n- O parâmetro **skip** serve para indicar as páginas a serem _puladas_ no retorno dos resultados. Enviando um valor skip = 0, portanto, indica que nenhuma página será _pulada_ e serão retornados os resultados a partir do índice 0.\n    \n- O parâmetro _take_ indica quantos resultados a busca deve retornar, ou seja, o tamanho de cada página. Enviando um valor take = 10, portanto, indica que serão retornados 10 resultados.\n    \n\nSendo assim, enviando um valor skip = 1 e take = 10, por exemplo, retorna os registros de 11 a 20.  \nUtilizando os dois parâmetros, pode-se percorrer toda a lista de resultados.\n\n# Listagem de recursos\n\nAlgumas APIs que retornam listas possuem o header **X-Total-Count** na resposta que informa a quantidade total de itens.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11173080","team":1115131,"collectionId":"c6ac84eb-144c-4527-99ed-277cd60be39f","publishedId":"UVeNo48G","public":true,"publicUrl":"https://docs.api.vgresiduos.com.br","privateUrl":"https://go.postman.co/documentation/11173080-c6ac84eb-144c-4527-99ed-277cd60be39f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.4","publishDate":"2022-02-14T21:10:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Sandbox","id":"fa68802a-e232-4b47-af77-a976c497a405","owner":"11173080","values":[{"key":"authUrl","value":"https://sandbox-login.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"baseUrl","value":"https://apiv2-sandbox.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"baseUrlCore","value":"https://apicore-sandbox.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"baseUrlDestinatorResiduesManagement","value":"https://apidestinatorresidues-sandbox.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"baseUrlResiduesManagement","value":"https://apiresiduesmanagement-sandbox.vertown.com","enabled":true,"type":"default"},{"key":"baseUrlSupplier","value":"https://apisuppliers-sandbox.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"baseUrlApiBI","value":"https://apibi-sbx.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"baseUrlResidues","value":"https://apiresidues-sandbox.vgresiduos.com.br","enabled":true,"type":"default"},{"key":"token","value":"","enabled":true,"type":"default"},{"key":"authClientId","value":"{{authClientId}}","enabled":true,"type":"default"},{"key":"authClientSecret","value":"{{authClientSecret}}","enabled":true,"type":"default"},{"key":"destinatorId","value":"","enabled":true,"type":"default"},{"key":"disposalTypeId","value":"{{disposalTypeId}}","enabled":true,"type":"default"},{"key":"estimatedGatheringDate","value":"{{estimatedGatheringDate}}","enabled":true,"type":"default"},{"key":"recipientId","value":"","enabled":true,"type":"default"},{"key":"recipientQuantity","value":"{{recipientQuantity}}","enabled":true,"type":"default"},{"key":"requestDate","value":"{{requestDate}}","enabled":true,"type":"default"},{"key":"residueId","value":"","enabled":true,"type":"default"},{"key":"transporterId","value":"","enabled":true,"type":"default"},{"key":"username","value":"{{username}}","enabled":true,"type":"default"},{"key":"onlyActive","value":"","enabled":true,"type":"default"},{"key":"includeOrganizationUnitResidues","value":"","enabled":true,"type":"default"}],"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/f8fdaa1951b285335c39bf6ed6f682d7453f0f0393f1ccdfd77cdc3f5e679b4f","favicon":"https://res.cloudinary.com/postman/image/upload/v1644874101/team/wrtozaio2zvuv3xs2jnt.ico"},"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":"Sandbox","value":"11173080-fa68802a-e232-4b47-af77-a976c497a405"}],"canonicalUrl":"https://docs.api.vgresiduos.com.br/view/metadata/UVeNo48G"}