{"info":{"_postman_id":"9f92fb60-676b-4a07-a3e5-b12f72a805dd","name":"Eclipse Client Gateway - Bespoke Documentation","description":"

EclipseNG Public API Endpoints

Authorisation

The endpoints require a valid bearer token to access.
Information on how to generate tokens is issued by our support team.

Endpoint URLs

In the examples below, the endpoints are all relative URLs.
If an example is opened in POSTMAN, a {mainUrl} variable is already prepended to the endpoints, which you will want to provide in your environment.

When calling from code, this value will want to be prepended manually.

The {mainUrl} value takes the format:
{customerEclipseUrl}/ClientGateway/api/

Standard Response Wrapper

All success responses from this API are wrapped in a common object

ReturnModel

The object returned by the endpoint (if any)

JobNumber

Nullable long datatype
\n
Indiciates the job number if the endpoint started a long running job
\n

MayRequireRerate

Boolean
\n
Indicates if the operation performed has made changes to the data that may require a rerate. This would require a separate request to be peformed to request the rerate.
\n

Model Example:

{\n     \"ReturnModel\": <Object Returned By Endpoint>,\n     \"JobNumber\": <long?>,\n     \"MayRequireRerate\": false\n}\n\n

Paged Endpoints

\"Paged search\" is our standardised method for returning data from the API. These endpoints allow filtering by any field returned in the parent object of the response model (nested objects are not supported), and some flexibility in how these filters are combined.
This flexibility should cover most data retrieval scenarios.

Example Explanation:

The example model below will result in data being returned where

Description is Equal To \"London CLI\"
\n
and
\n
Phonenumber Contains \"020\"
\n

Description Equal To \"Manchester CLI\"
\n
and
\n
Phonenumber Contains \"0161\"
\n

The example model below will sort the data by LastUpdated Descending

Model Example:

{\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

Fields

PageNumber

Mandatory
\n
1 based integer
\n

PageSize

Mandatory
\n
Max 1000
\n

GroupedFilterExpressions

Optional array
- FilterExpressions
  \n
  - Array of One or more FilterExpression model
  \n
- FilterExpressionsUsingOR
  \n
  - Optional
    \n
  - Defaults to false
    \n
  - Operates on the Filter Expressions within the group
    \n
  \n
\n

FilterExpresssionsUsingOr

Optional
\n
Defaults to false
\n
Operaties on the Grouped Filter Expressions
\n

SortExpressions

Optional
\n
Defaults to data appropriate value (generally the id)
\n
Can combine any return field
\n

Additional Resources

Filter Function

Individual filter expressions allowing filtering on fields. The FilterFunction can be one of the following values:

Contains
\n
DoesNotContain
\n
StartsWith
\n
EndsWith
\n
EqualTo
\n
NotEqualTo
\n
GreaterThan
\n
LessThan
\n
GreaterThanOrEqualTo
\n
LessThanOrEqualTo
\n
IsEmpty
\n
- Does not require FieldValue
\n
NotIsEmpty
\n
- Does not require FieldValue
\n
IsNull
\n
- Does not require FieldValue
\n
NotIsNull
\n
- Does not require FieldValue
\n
In
\n
- Expects data in a comma delimited list
  \n
- Non numeric fields should have values qualified with \"
  \n
\n
IsNotIn
\n
- Expects data in a comma delimited list
  \n
- Non numeric fields should have values qualified with \"
  \n
\n

You should consider the function you are attempting to use and whether it is appropriate for the data value you are attempting to search by.

i.e. If you are searching on a date field, the StartsWith filter function would not be suitable.

Sort Order

Ascending = 1
\n
Descending = 2
\n

Validation Return Model

When invalid data is received, we will return it in a standardised format (HTTP 400).
This matches validation errors auto generated by the framework we use for consistency.

Model Example:

{\n  \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n  \"title\": \"One or more validation errors occurred.\",\n  \"status\": 400,\n  \"traceid\": \"\",\n  \"errors\": {\n    \"ErrorHeader\": [\n      \"Error Description 1\",\n      \"Error Description 2\"\n     ],\n     \"ErrorHeader2\": [\n      \"Error Description 3\"\n     ]\n  }\n}\n\n

Endpoint Deprecation

The Eclipse APIs are constantly being developed. Where a change is made that requires an endpoint to be deprecated, a header will be included in the response indicating that the endpoint is obsolete & when it will be removed completely.
Where an alternative is available, the documenation should indicate this.

\n\n

If the obsolete header is returned, on or before the date, the endpoint will continue to operate as normal.
After this date, the endpoint will return a HTTP 403 response

Example Header Value:

{\n     \"Obsolete\": \"2024-03-26\"\n}\n\n

Example 403 Response:

{\n  \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n  \"title\": \"One or more validation errors occurred.\",\n  \"status\": 400,\n  \"traceid\": \"\",\n  \"errors\": {\n    \"Endpoint no longer available\": [\n      \"This end point is no longer accessible as the obsolete date: 2024-03-26 has passed.\"\n    ]\n  }\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"EclipseNG Public API Endpoints","slug":"eclipseng-public-api-endpoints"},{"content":"Authorisation","slug":"authorisation"},{"content":"Endpoint URLs","slug":"endpoint-urls"},{"content":"Standard Response Wrapper","slug":"standard-response-wrapper"},{"content":"Paged Endpoints","slug":"paged-endpoints"},{"content":"Validation Return Model","slug":"validation-return-model"},{"content":"Endpoint Deprecation","slug":"endpoint-deprecation"}],"owner":"50512230","collectionId":"9f92fb60-676b-4a07-a3e5-b12f72a805dd","publishedId":"2sBXcGCe9k","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-23T16:34:57.000Z"},"item":[{"name":"Bulk Update","item":[{"name":"v1","item":[{"name":"Reconnection","id":"211f34ba-1e37-4223-9973-6e39d1e2be8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"BatchId\": 1,\n \"Connections\": [{\n \"AccountNumber\": \"Account1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876548,\n \"Date\": \"2024-05-04\"\n },\n {\"AccountNumber\": \"Account1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876549,\n \"Date\": \"2024-05-04\"\n }\n\n\t]\n}"},"url":"{{mainUrl}}v1/BulkUpdate/Reconnection","description":"

Reconnects the supplied ICCIDs using the date provided or todays date if it is not.

\n","urlObject":{"path":["BulkUpdate","Reconnection"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"096ce879-2c02-44cc-8682-b19547c1fefe","name":"Reconnection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"BatchId\": 1,\n \"Connections\": [{\n \"AccountNumber\": \"AccountNumber1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876548,\n \"Date\": \"2024-05-04\"\n },\n {\"AccountNumber\": \"AccountNumber1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876549,\n \"Date\": \"2024-05-04\"\n }]\n}"},"url":"{{mainUrl}}v1/BulkUpdate/Reconnection"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ValidationErrorCount\": 0,\n \"TotalProcessedRecords\": 1,\n \"HeaderValidatonCode\": 7,\n \"ValidationErrors\": []\n}"}],"_postman_id":"211f34ba-1e37-4223-9973-6e39d1e2be8f"},{"name":"Disconnection","id":"fbd51323-d2b3-43cd-8cb6-c4c673d060a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"BatchId\": 1,\n \"Connections\": [{\n \"AccountNumber\": \"Account1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876548,\n \"Date\": \"2024-05-04\"\n },\n {\"AccountNumber\": \"Account1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876549,\n \"Date\": \"2024-05-04\"\n }\n\n\t]\n}"},"url":"{{mainUrl}}v1/BulkUpdate/Disconnection","description":"

Disconnects the supplied ICCIDs using the date provided or todays date if it is not.

\n","urlObject":{"path":["BulkUpdate","Disconnection"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"0abefb9e-20f2-4cb1-b038-f889708a5f2a","name":"Disconnection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"BatchId\": 1,\n \"Connections\": [{\n \"AccountNumber\": \"AccountNumber1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876548,\n \"Date\": \"2024-05-04\"\n },\n {\"AccountNumber\": \"AccountNumber1\",\n \"ConnectionId\": 1,\n \"ICCID\": 18366876549,\n \"Date\": \"2024-05-04\"\n }]\n}"},"url":"{{mainUrl}}v1/BulkUpdate/Disconnection"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ValidationErrorCount\": 0,\n \"TotalProcessedRecords\": 1,\n \"HeaderValidatonCode\": 7,\n \"ValidationErrors\": []\n}"}],"_postman_id":"fbd51323-d2b3-43cd-8cb6-c4c673d060a2"}],"id":"524010ac-75bb-4ee4-98d8-eb5ec6d32933","_postman_id":"524010ac-75bb-4ee4-98d8-eb5ec6d32933","description":""}],"id":"79c1b929-d863-484a-916c-5a6367fb8f88","_postman_id":"79c1b929-d863-484a-916c-5a6367fb8f88","description":""},{"name":"CLI","item":[{"name":"Subscription Status","item":[{"name":"Search Cli Subscription Status Paged","id":"cd209cda-916a-469a-bd4d-efde00867bcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\":\"SubscriptionStatus.Id\",\r\n \"FieldValue\":\"2\",\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"CliId\",\r\n \"SortOrder\": \"Ascending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/SubscriptionStatus/SearchCliSubscriptionStatusPaged","urlObject":{"path":["SubscriptionStatus","SearchCliSubscriptionStatusPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"a1f3c127-c3c3-4219-bae8-7b94bca18ef3","name":"Search Cli Subscription Status Paged","originalRequest":{"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\":\"SubscriptionStatus.Id\",\r\n \"FieldValue\":\"2\",\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"CliId\",\r\n \"SortOrder\": \"Ascending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/SubscriptionStatus/SearchCliSubscriptionStatusPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 2,\n \"ItemsPerPage\": 50,\n \"Items\": [\n {\n \"CliId\": 1242,\n \"ConnectionId\": null,\n \"SubscriptionStatus\": {\n \"Id\": 2,\n \"Name\": \"Active\"\n },\n \"LastUpdated\": \"2024-11-08T11:41:15.1084916+00:00\"\n },\n {\n \"CliId\": 1243,\n \"ConnectionId\": null,\n \"SubscriptionStatus\": {\n \"Id\": 2,\n \"Name\": \"Active\"\n },\n \"LastUpdated\": \"2024-11-08T11:41:17.2996611+00:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"cd209cda-916a-469a-bd4d-efde00867bcc"},{"name":"Get Pick Subscription Statuses","id":"ba652f81-c5e5-4b1b-8e33-eeb28b756cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/SubscriptionStatus/GetPickSubscriptionStatuses","urlObject":{"path":["SubscriptionStatus","GetPickSubscriptionStatuses"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"fd21c902-a0ae-45c0-a199-7e2814d17973","name":"Get Pick Subscription Statuses","originalRequest":{"method":"GET","header":[{"key":"customerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/SubscriptionStatus/GetPickSubscriptionStatuses"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Name\": \"Test\"\n },\n {\n \"Id\": 2,\n \"Name\": \"Active\"\n },\n {\n \"Id\": 3,\n \"Name\": \"Deactivated\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"ba652f81-c5e5-4b1b-8e33-eeb28b756cb1"}],"id":"6179119a-4a14-4bf4-9fe1-220a0d7dc881","_postman_id":"6179119a-4a14-4bf4-9fe1-220a0d7dc881","description":""},{"name":"Number Routing","item":[{"name":"v1","item":[{"name":"Search Custom Number Route Paged","id":"10ff93c4-6145-4bbb-a561-f525e0fcaccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"LastUpdated\",\n \"FieldValue\": \"2023-12-11\",\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\":[\n {\n \"FieldName\": \"LastUpdated\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 500\n}"},"url":"{{mainUrl}}v1/NumberRouting/SearchCustomNumberRoutePaged","urlObject":{"path":["NumberRouting","SearchCustomNumberRoutePaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"4f32e520-7dc3-4ea4-b460-35e13660a58f","name":"Search Custom Number Route Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"LastUpdated\",\n \"FieldValue\": \"2023-12-11\",\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\":[\n {\n \"FieldName\": \"LastUpdated\",\n \"sortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 500\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/NumberRouting/SearchCustomNumberRoutePaged"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"5079"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Rate-Limit-Limit","value":"7d"},{"key":"X-Rate-Limit-Remaining","value":"9999"},{"key":"X-Rate-Limit-Reset","value":"2024-02-13T16:33:23.8077258Z"},{"key":"Date","value":"Tue, 06 Feb 2024 16:33:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 5,\n \"ItemsPerPage\": 500,\n \"Items\": [\n {\n \"numberStartDate\": \"2023-01-15T00:00:00Z\",\n \"number\": \"CLI 1\",\n \"primaryRouteRule\": \"1 - Route 1 - Desc 1\",\n \"secondaryRouteRule\": null,\n \"tertiaryRouteRule\": null,\n \"telId\": 1,\n \"primaryRoute\": \"CLI 1\",\n \"primaryRouteRuleId\": 1,\n \"secondaryRoute\": null,\n \"secondaryRouteRuleId\": null,\n \"tertiaryRoute\": null,\n \"tertiaryRouteRuleId\": null,\n \"cliFromHeader\": \"\",\n \"lastUpdated\": \"2024-02-06T15:47:34.5071049+00:00\",\n \"timeOutSeconds\": 21600\n },\n {\n \"numberStartDate\": \"2023-01-01T00:00:00Z\",\n \"number\": \"CLI 2\",\n \"primaryRouteRule\": \"2 - Route 2 - Desc 2\",\n \"secondaryRouteRule\": null,\n \"tertiaryRouteRule\": null,\n \"telId\": 2,\n \"primaryRoute\": \"CLI 2\",\n \"primaryRouteRuleId\": 2,\n \"secondaryRoute\": null,\n \"secondaryRouteRuleId\": null,\n \"tertiaryRoute\": null,\n \"tertiaryRouteRuleId\": null,\n \"cliFromHeader\": \"\",\n \"lastUpdated\": \"2024-02-06T15:24:26.2741388+00:00\",\n \"timeOutSeconds\": 21600\n },\n {\n \"numberStartDate\": \"2024-01-31T00:00:00Z\",\n \"number\": \"CLI 3\",\n \"primaryRouteRule\": \"3 - Route 3 - Desc 3\",\n \"secondaryRouteRule\": null,\n \"tertiaryRouteRule\": null,\n \"telId\": 3,\n \"primaryRoute\": \"CLI 3\",\n \"primaryRouteRuleId\": 3,\n \"secondaryRoute\": null,\n \"secondaryRouteRuleId\": null,\n \"tertiaryRoute\": null,\n \"tertiaryRouteRuleId\": null,\n \"cliFromHeader\": \"\",\n \"lastUpdated\": \"2024-02-01T08:50:02.4642649+00:00\",\n \"timeOutSeconds\": 21600\n },\n {\n \"numberStartDate\": \"2024-01-31T00:00:00Z\",\n \"number\": \"CLI 4\",\n \"primaryRouteRule\": \"4 - Route 5 - Desc 5\",\n \"secondaryRouteRule\": \"5 - Route 5 - Desc 5\",\n \"tertiaryRouteRule\": null,\n \"telId\": 4,\n \"primaryRoute\": \"primary\",\n \"primaryRouteRuleId\": 4,\n \"secondaryRoute\": \"secondary\",\n \"secondaryRouteRuleId\": 5,\n \"tertiaryRoute\": null,\n \"tertiaryRouteRuleId\": null,\n \"cliFromHeader\": \"header\",\n \"lastUpdated\": \"2024-01-31T12:28:47.1893659+00:00\",\n \"timeOutSeconds\": 100\n },\n {\n \"numberStartDate\": \"2024-01-31T00:00:00Z\",\n \"number\": \"CLI 5\",\n \"primaryRouteRule\": \"6 - Route 6 - Desc 6\",\n \"secondaryRouteRule\": \"7 - Route 7 - Desc 7\",\n \"tertiaryRouteRule\": null,\n \"telId\": 5,\n \"primaryRoute\": \"primary\",\n \"primaryRouteRuleId\": 6,\n \"secondaryRoute\": \"secondary\",\n \"secondaryRouteRuleId\": 7,\n \"tertiaryRoute\": null,\n \"tertiaryRouteRuleId\": null,\n \"cliFromHeader\": \"header\",\n \"lastUpdated\": \"2024-01-31T12:20:23.4195635+00:00\",\n \"timeOutSeconds\": 100\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"10ff93c4-6145-4bbb-a561-f525e0fcaccc"}],"id":"d9f04000-2465-4293-8ad0-0b2bfac490bc","_postman_id":"d9f04000-2465-4293-8ad0-0b2bfac490bc","description":""}],"id":"473d09e6-97e4-4567-9ee5-124eb2e90ee4","description":"

Contains endpoints relating to the Number Routing on a CLI

\n","_postman_id":"473d09e6-97e4-4567-9ee5-124eb2e90ee4"}],"id":"f8716e9a-a28a-4b36-8c3b-8e31dde89467","description":"

Contains endpoints relating to the CLI

\n","_postman_id":"f8716e9a-a28a-4b36-8c3b-8e31dde89467"},{"name":"Tariff Package","item":[{"name":"v1","item":[{"name":"Search Tariff Package Paged","id":"2c0a207a-f1d0-46ee-95bd-6ab2e5653460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"PackageName\",\n \"FieldValue\": \"Mock Package\",\n \"FilterFunction\": \"Contains\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\":[\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 500\n}"},"url":"{{mainUrl}}v1/TariffPackage/SearchTariffPackagePaged","urlObject":{"path":["TariffPackage","SearchTariffPackagePaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"03c2e601-5661-4dde-a2e4-8ec3ee0c9a5f","name":"Search Tariff Package Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"PackageName\",\n \"FieldValue\": \"Mock Package\",\n \"FilterFunction\": \"Contains\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\":[\n {\n \"FieldName\": \"Id\",\n \"sortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 1000\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/TariffPackage/SearchTariffPackagePaged"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 1,\r\n \"TotalItems\": 2,\r\n \"ItemsPerPage\": 1000,\r\n \"Items\": [\r\n {\r\n \"Id\": 1,\r\n \"PackageName\": \"Mock Package 1\",\r\n \"PackageCode\": \"Code1\",\r\n \"IsActive\": true,\r\n \"AutoProvision\": true,\r\n \"ProductType\": {\r\n \"Id\": 1,\r\n \"Description\": \"Product Type 1\"\r\n },\r\n \"ConnectionCount\": 2,\r\n \"RSIMOTAProfile\": {\r\n \"Id\": 1,\r\n \"Description\": \"rSIM OTA Profile 1\"\r\n },\r\n \"Connections\": [\r\n {\r\n \"MNO\": {\r\n \"Id\": 1,\r\n \"Name\": \"MNO 1\"\r\n },\r\n \"MNORatePlan\": {\r\n \"Id\": 1,\r\n \"Description\": \"MNO Rate Plan 1\"\r\n },\r\n \"Enterprise\": {\r\n \"Id\": 1,\r\n \"Description\": \"Enterprise 1\"\r\n },\r\n \"MNOServicePlan\": {\r\n \"Id\": 1,\r\n \"Description\": \"MNO Service Plan 1\"\r\n },\r\n \"IsPrimaryConnection\": true\r\n },\r\n {\r\n \"MNO\": {\r\n \"Id\": 2,\r\n \"Name\": \"MNO 2\"\r\n },\r\n \"MNORatePlan\": {\r\n \"Id\": 2,\r\n \"Description\": \"MNO Rate Plan 2\"\r\n },\r\n \"Enterprise\": {\r\n \"Id\": 2,\r\n \"Description\": \"Enterprise 2\"\r\n },\r\n \"MNOServicePlan\": {\r\n \"Id\": 2,\r\n \"Description\": \"MNO Service Plan 2\"\r\n },\r\n \"IsPrimaryConnection\": false\r\n }\r\n ]\r\n },\r\n {\r\n \"Id\": 2,\r\n \"PackageName\": \"Mock Package 2\",\r\n \"PackageCode\": \"Code2\",\r\n \"IsActive\": true,\r\n \"AutoProvision\": true,\r\n \"ProductType\": {\r\n \"Id\": 2,\r\n \"Description\": \"Product Type 2\"\r\n },\r\n \"ConnectionCount\": 1,\r\n \"RSIMOTAProfile\": {\r\n \"Id\": 2,\r\n \"Description\": \"rSIM OTA Profile 2\"\r\n },\r\n \"Connections\": [\r\n {\r\n \"MNO\": {\r\n \"Id\": 3,\r\n \"Name\": \"MNO 3\"\r\n },\r\n \"MNORatePlan\": {\r\n \"Id\": 3,\r\n \"Description\": \"MNO Rate Plan 3\"\r\n },\r\n \"Enterprise\": {\r\n \"Id\": 3,\r\n \"Description\": \"Enterprise 3\"\r\n },\r\n \"MNOServicePlan\": {\r\n \"Id\": 3,\r\n \"Description\": \"MNO Service Plan 3\"\r\n },\r\n \"IsPrimaryConnection\": true\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"2c0a207a-f1d0-46ee-95bd-6ab2e5653460"}],"id":"cda785c1-906d-4287-ac99-06dc641d9a2a","_postman_id":"cda785c1-906d-4287-ac99-06dc641d9a2a","description":""}],"id":"335bb5da-c37b-405c-85d3-d10783c298f3","description":"

Contains endpoints relating to the Tariff Packages

\n","_postman_id":"335bb5da-c37b-405c-85d3-d10783c298f3"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7a1940cd-93a7-4a09-bfa0-cbcaa04cfe01"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a381ab99-1b8b-420c-aef6-85baf1ce1454"}}]}