{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"659958c7-9050-4eb2-bc75-b514b5c4607a","name":"NG Web API Public Documentation Collection","description":"# EclipseNG Public API Endpoints\n\nPlease note that access to this API is read-only by default. If you require access to anything other than GET end points then please speak to our I.T. Department.\n\n# Paged Endpoints\n\n\\*This is a new standard which has limited rollout but should become increasingly common.\n\nIf you encounter an end point which returns paged data you will be required to provide the following in the body of the request:\n\n- PageNumber - (Mandatory)\n- PageSize - (Mandatory)\n    \n\nAdditionally, you may provide:\n\n- FilterExpressions - (Optional)\n- SortExpressions - (Optional)\n    \n\n_**FilterExpressions**_\n\nThis is a an array containing one or more of the following model:\n\n``` json\n{\n   \"FieldName\":\"PutFieldNameHere\",\n   \"FieldValue\":\"PutFieldValueHere\",\n   \"FilterFunction\":\"PutFilterFunctionHere\"\n}\n\n```\n\nThe FilterFunction can be one of the following values:\n\n- NoFilter = 0 (This is effectively the same as not providing the Filter Expression at all)\n- Contains = 1\n- DoesNotContain = 2\n- StartsWith = 3\n- EndsWith = 4\n- EqualTo = 5\n- NotEqualTo = 6\n- GreaterThan = 7\n- LessThan = 8\n- GreaterThanOrEqualTo = 9\n- LessThanOrEqualTo = 10\n- IsEmpty = 13\n- NotIsEmpty = 14\n- IsNull = 15\n- NotIsNUll = 16\n- In = 17\n- IsNotIn = 18\n    \n\nPlease consider the function you are attempting to use and whether it is appropriate for the data value you are attempting to search by. For example if you are searching on a date value a StartsWith filter function would not be suitable.\n\n_**SortExpressions**_\n\nThis is a an array containing one or more of the following model:\n\n``` json\n{\n   \"FieldName\":\"PutFieldNameHere\",\n   \"SortOrder\":\"SortOrder\"\n}\n\n```\n\nThe Sort Order can be one of the following:\n\n- None = 0\n- Ascending = 1\n- Descending = 2\n    \n\nPlease note that some requests will have a version 2 Endpoint as such the headers in the version 1 should have an obsolete header indicating that you should consume the version 2 moving forward.\n\n_**GroupedFilterExpression**_\n\nFor more complex filtering we allow grouped filter expressions where they can be separated by an OR operator to search data at a granular level.\n\nThis is an array containing two sets of filter expressions which are compared with the `FilterExpressionsUsingOR` field.\n\n``` json\n{\n    \"GroupedFilterExpressions\": [\n        {\n            \"FilterExpressions\":\n            [\n                {\n                    \"FieldName\": \"Description\",\n                    \"FieldValue\": \"London CLI\",\n                    \"FilterFunction\": \"EqualTo\"\n                },\n                {\n                    \"FieldName\": \"Phonenumber\",\n                    \"FieldValue\": \"020\",\n                    \"FilterFunction\": \"Contains\"\n                }\n            ]\n        },\n        {\n            \"FilterExpressions\":\n            [\n                {\n                    \"FieldName\": \"Description\",\n                    \"FieldValue\": \"Manchester CLI\",\n                    \"FilterFunction\": \"EqualTo\"\n                },\n                {\n                    \"FieldName\": \"Phonenumber\",\n                    \"FieldValue\": \"0161\",\n                    \"FilterFunction\": \"Contains\"\n                }\n            ]\n        }\n    ],\n    \"FilterExpressionsUsingOR\": true,\n    \"SortExpressions\": [\n        {\n            \"FieldName\": \"LastUpdated\",\n            \"SortOrder\": 2\n        }\n    ],\n    \"PageNumber\": 1,\n    \"PageSize\": 500\n}\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"50512230","team":2053486,"collectionId":"659958c7-9050-4eb2-bc75-b514b5c4607a","publishedId":"2sBXcGCe5L","public":true,"publicUrl":"https://api-doc.eclipse-billing.co.uk","privateUrl":"https://go.postman.co/documentation/50512230-659958c7-9050-4eb2-bc75-b514b5c4607a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2026-02-23T16:19:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/4a31687a7838401b4e2108f73dfcbdbdb12bd25df330f971fb86d445da4185aa","favicon":"https://eclipse-billing.co.uk/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://api-doc.eclipse-billing.co.uk/view/metadata/2sBXcGCe5L"}