{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"401a866d-da53-4965-bae7-103e96e19846","name":"Gresham Control REST API","description":"Welcome to Gresham Control REST API. Here are some pre-made requests for you to explore the API using [Postman](https://getpostman.com).\n\n# Authorization and OAuth\n\nGresham Control API OAuth 2.0 protocol which conforms to the OpenID Connect specification for authentication and authorization.\n\nGresham Control API supports common OAuth 2.0 scenarios such as those for web server, client-side, installed, and limited-input device applications.\n\nTo begin, obtain OAuth 2.0 client credentials from the Gresham Support Team [electracontrolsupport@greshamtech.com](https://mailto:electracontrolsupport@greshamtech.com).\n\nUse provided information to make a request to the Identity Server to retrieve an access token.\n\nMake your API requests by sending the Authorization header as such:  \n`Authorization: Bearer YOUR_ACCESS_TOKEN`\n\n#### Note:\n\nTo make testing and exploring Gresham Control API easier and convenient all requests are using an authorization helper from collection Gresham Control REST API.  \nSee `Pre-request Scripts` inside Gresham Control REST API collection for more details.\n\nIf you are making a request to the API from custom code, you will need to add Authorization header, `Authorization: Bearer YOUR_ACCESS_TOKEN`.\n\nYou can find an example of creating client application and calling API here: [Creating the client](https://identityserver4.readthedocs.io/en/latest/quickstarts/1_client_credentials.html#creating-the-client)\n\n# Environments\n\nWe are providing \"UAT REST API Environment\" as a part of the Postman test environment. You will need to request values for all parameters marked with .\n\n| Variable | Value | Description |\n| --- | --- | --- |\n| idpAuthority |  | Identity Server URL |\n| baseUrl |  | Gresham Control API URL |\n| clientId |  | API id |\n| clientSecret |  | API secret |\n| scope |  | API access scope |\n\n# Responses\n\nEach response is wrapped in a data tag. This means if you have a response, it will always be within the \"data\" tag.  \nIf resource supports pagination, \"paginationInfo\" tag will be also included in the response.\n\nExample:\n\n```\n{\"data\": [\n        {\"key\": value},\n        {\"key\": value},\n    ],\n    \"paginationInfo\": {\n        \"pageNumber\": 3,\n        \"pageSize\": 500,\n        \"totalPages\": 4,\n        \"totalCount\": 1775}\n}\n\n ```\n\n## Compressed Responses\n\nWhen making a request the client can choose to receive a compressed response payload of a specific format by specifying an `Accept-Encoding` header. The encodings gzip and Brotli are supported. To request a compressed response include the header `Accept-Encoding: gzip` or `Accept-Encoding: br` in the request.\n\nThe client is responsible for decoding the response. The client can inspect the response headers for the Content-Encoding header to determine if the response is compressed. For example, `Content-Encoding: br`.\n\n# Paging Results\n\nIf \"paginationInfo\" tag is included in the response, you can page it via a query string parameter.\n\n| Query String Parameter | Required | Description |\n| --- | --- | --- |\n| pageNumber | optional | Page number of the result set (default: 1) |\n| pageSize | optional | Limit the number of results per page. (default: 500, max: 1000) |\n\nExample:\n\n/smart-search-filters/{{filterId}}/data?pageSize=100&pageNumber=3","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"11216345","team":978431,"collectionId":"401a866d-da53-4965-bae7-103e96e19846","publishedId":"T17GgU8F","public":true,"publicUrl":"https://apidocs-reconciliation.electrainfo.com","privateUrl":"https://go.postman.co/documentation/11216345-401a866d-da53-4965-bae7-103e96e19846","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-11-02T19:41:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"UAT REST API Environment","id":"0a7b1d66-10a4-4877-ab1f-f858a91f92ec","owner":"11216345","values":[{"key":"idpAuthority","value":"<ask support>","enabled":true},{"key":"baseUrl","value":"<ask support>","enabled":true},{"key":"clientId","value":"<ask support>","enabled":true},{"key":"clientSecret","value":"<ask support>","enabled":true},{"key":"scope","value":"<ask support>","enabled":true}],"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/366329cf6df396098456b502bf38d91426525f308588178a47363192ae6602a0","favicon":"https://res.cloudinary.com/postman/image/upload/v1644324457/team/wd7hdsry12gpjsi96mc4.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":"UAT REST API Environment","value":"11216345-0a7b1d66-10a4-4877-ab1f-f858a91f92ec"}],"canonicalUrl":"https://apidocs-reconciliation.electrainfo.com/view/metadata/T17GgU8F"}