Roaming Profiles⚓︎
Path⚓︎
/v1/roaming-profiles
A Roaming Profile defines 3GPP roaming restrictions for Subscribers, Sites, or Systems. It specifies which Carrier Groups a subscriber is allowed to attach to.
Resource Attributes⚓︎
The attributes for the roaming-profiles resource are detailed below:
| Attribute | Type | Required? | Description |
|---|---|---|---|
| name | String | YES | The name of the roaming profile. |
| description | String | NO | A description of the roaming profile. |
| customer | String | YES | The customer associated with this roaming profile (link). |
Example⚓︎
{
"name": "Standard Roaming",
"description": "Standard roaming restrictions for employees",
"customer": "{baseUrl}/v1/customers/123"
}
Endpoints⚓︎
Request Examples⚓︎
Get a list of all roaming profiles:⚓︎
{baseUrl}/v1/roaming-profiles
Get a specific roaming profile:⚓︎
{baseUrl}/v1/roaming-profiles/<profileID>
Get allowed carrier groups for a roaming profile:⚓︎
{baseUrl}/v1/roaming-profiles/<profileID>/allowedCarrierGroups
Get all subscribers using a roaming profile:⚓︎
{baseUrl}/v1/roaming-profiles/<profileID>/subscribers
Get all sites associated with a roaming profile:⚓︎
{baseUrl}/v1/roaming-profiles/<profileID>/sites
Get all systems associated with a roaming profile:⚓︎
{baseUrl}/v1/roaming-profiles/<profileID>/systems
Search for roaming profiles with counts:⚓︎
{baseUrl}/v1/roaming-profiles/search/findByDeepSearchWithCounts?searchString=<searchCriteria>
Find by name and customer (including parents):⚓︎
{baseUrl}/v1/roaming-profiles/search/findByNameAndCustomerWithParents?name=<name>&customer=<customerRef>
The