{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","description":"This API allows you to access the data of an HiperME plataform.\n\nAll HiperME platforms from version 1.5 have the API and all the endpoints of the API has the prefix `api`. Example: [https://example.hiperpbx.com/api/endpointexample](https://example.hiperpbx.com/api/endpointexample)\n\n> You can only access the following resources if the user has the role '**ROLE_ADMIN**'. \n  \n\n- Media Servers\n- Firebase\n    \n\n# Getting started\n\nWhen working with Postman, make sure that the variable `hiperme_url` is defined.\n\n## Using Endpoints\n\nWhen creating or updating, you will see that almost everytime, you have to send a Endpoint. An Endpoint indicates the resource to use, for example, when creating an Extension, you have to indicate the organization that the is releated to by using the value `/api/organizations/:id` where id indicates the id of the organization.\n\n## Aditional properties\n\nWhen getting a resource, it will have three additional properties `@id`, that contains the endpoint of the resource, `@type` that is the type of resource and `@context`.\n\nWhen getting a list of resources, the JSON response it will look like this.\n\n```\n{\n    \"@context\": \"/api/contexts/Extension\",\n    \"@id\": \"/api/extensions\",\n    \"@type\": \"hydra:Collection\",\n    \"hydra:member\": [\n        ...\n    ],\n    \"hydra:totalItems\": 2\n}\n\n ```\n\nThe resources are in the property `hydra:member`\n\n# Authorization\n\nAn JWT Token is required to be sent as part of every request to the HiperME API (except in the [Get JWT Token](https://solar-capsule-663493.postman.co/collections/5674311-4813fc2d-1793-4b33-908d-b9732fb77ca6?version=latest&workspace=a3d3a567-9848-46f5-8c81-7a8ae18eeadc#0d6ba95d-533e-464a-890f-b2123ce31aa5) endpoint) in the form of an `Bearer Token` request header.\n\n## Authorization releated errors response\n\nIf an JWT Token is missing, malformed or invalid, you will receive a `401 Unauthorised` response code and one of the following JSON response.\n\n```\n{\n    \"code\": 401,\n    \"message\": \"Invalid credentials.\"\n}\n\n ```\n\n```\n{\n    \"code\": 401,\n    \"message\": \"Expired JWT Token\"\n}\n\n ```\n\n# Errors\n\nThe HiperMe API uses convetional HTTP response codes to indicate the success of failure of an request. Code in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted, validation errors, resource not found, etc.)\n\n## Validations errors\n\nWhen creating or updating a resource, if the body request is invalid, you will recive a `400 Bad Request` response code and a JSON response like this.\n\n```\n{\n    \"@context\": \"/api/contexts/ConstraintViolationList\",\n    \"@type\": \"ConstraintViolationList\",\n    \"hydra:title\": \"An error occurred\",\n    \"hydra:description\": \"name: This value is already used.\",\n    \"violations\": [\n        {\n            \"propertyPath\": \"name\",\n            \"message\": \"This value is already used.\"\n        }\n    ]\n}\n\n ```\n\nIn the violations property, you will get an array of objects with all the validation errors. Every object will have \"propertyPath\" (this is the name of the invalid field) and \"message\" containing the error.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5674311","team":1406263,"collectionId":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","publishedId":"TW73DQTM","public":true,"publicUrl":"https://apidoc.hiperpbx.com","privateUrl":"https://go.postman.co/documentation/5674311-c70ef614-bd43-4167-8d28-3a3fcb5a0162","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-04-21T16:16:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/cd50cb7c1b83886205ff036e1048caba0e43eeafffdc458a34dbc7734f82e6e9","favicon":"https://hiperpbx.com/favicon.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"}],"canonicalUrl":"https://apidoc.hiperpbx.com/view/metadata/TW73DQTM"}