Skip to content

Latest commit

 

History

History
239 lines (129 loc) · 7.3 KB

LookupsApi.md

File metadata and controls

239 lines (129 loc) · 7.3 KB
Raw

\LookupsApi

All URIs are relative to https://cdn.emnify.net

Method HTTP request Description
breakout_region_get GET /api/v1/breakout_region List Breakout Regions
country_get GET /api/v1/country List Country Codes
currency_get GET /api/v1/currency List Currencies
data_blocksize_get GET /api/v1/data_blocksize List Data blocksizes
data_throttle_get GET /api/v1/data_throttle List Data Throttles
esme_interface_type_get GET /api/v1/esme_interface_type List ESME Interface Types
list_service_levels GET /api/v1/service_level Get list of service levels
rat_type GET /api/v1/rat_type List RAT types

breakout_region_get

Veccrate::models::RetrieveAvailableBreakoutRegionsresponse breakout_region_get() List Breakout Regions

Provides the list of available breakout regions.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveAvailableBreakoutRegionsresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

country_get

Veccrate::models::RetrieveAvailableCountriesresponse country_get(geographic) List Country Codes

Provides the list of available countries (lookup).

Parameters

Name Type Description Required Notes
geographic Option<bool> Filters the country list for geographic countries only. This will exclude duplicate countries with different MCCs, like India MCC 405 or United States (311).

Return type

Veccrate::models::RetrieveAvailableCountriesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

currency_get

Veccrate::models::RetrieveAvailableCurrenciesresponse currency_get() List Currencies

Provides the list of available currencies (lookup).

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveAvailableCurrenciesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

data_blocksize_get

Veccrate::models::RetrieveAvailableDataBlocksizesresponse data_blocksize_get() List Data blocksizes

Provides the list of available data blocksizes (lookup).

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveAvailableDataBlocksizesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

data_throttle_get

Veccrate::models::RetrieveAvailableDataThrottlesresponse data_throttle_get() List Data Throttles

Provides the list of available data throttles (lookup).

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveAvailableDataThrottlesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

esme_interface_type_get

Veccrate::models::RetrieveAvailableEsmeInterfaceTypesresponse esme_interface_type_get() List ESME Interface Types

Provides the list of available ESME interface types.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveAvailableEsmeInterfaceTypesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_service_levels

Veccrate::models::OrganisationTariffPlanByOrgIdGet200ResponseInnerTariffPlanServiceLevel list_service_levels() Get list of service levels

Returns a list of service levels that can be configured on a tariff plan level. For non-enterprise organisations, only own service levels will be returned. For enterprise organisations, only the service levels of the parent organisation will be returned.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::OrganisationTariffPlanByOrgIdGet200ResponseInnerTariffPlanServiceLevel

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rat_type

Veccrate::models::RatType rat_type(blacklistable, limitable) List RAT types

Returns a list of supported RAT types.

Parameters

Name Type Description Required Notes
blacklistable Option<bool> Returns a list of RAT types that can be blacklisted for network coverage data. /api/v1/rat_type?blacklistable
limitable Option<bool> Returns a list of RAT types that can be limited for a pdp_context_definition /api/v1/rat_type?limitable

Return type

Veccrate::models::RatType

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]