masstack

V1
V2
API Overview Resources Schemas

Broadband

Broadband resource represents a broadband connection subscription containing specific broadband connection data besides all data applicable to any subscription

Parameters

Name In Type Required Description
offset query integer false Pagination offset
limit query integer false Pagination limit
org path string true Organization identifier
id path string true Subscription bundle unique identifier
mandatory query boolean false Mandatory subscription filter

Request example

1
2
3
4
5


curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/bundles/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/subscriptions/broadband?offset='0'&limit='50'&mandatory='true' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK BroadbandSet
403 Forbidden Forbidden access ErrorResponse
404 Not Found A bundle with the specified id was not found ErrorResponse
500 Internal Server Error Internal server error ErrorResponse
default Default Any client or server error ErrorResponse

Parameters

Name In Type Required Description
org path string true Organization name
legacy_id query integer false Legacy id. Required if ‘legacy_account_id’ and ‘legacy_service_id’ filters are not provided
legacy_account_id query integer false Account id the subscription is linked to. Required if ‘legacy_id’ and ‘legacy_service_id’ filters are not provided. Linked
to MySim/Apollo storage, to be deprecated.
legacy_service_id query string false Work order id according to mas-installations definition. Required if ‘legacy_id’ and ‘legacy_account_id’ filters are not provided
legacy_bundle_id query integer false Legacy bundle id
mandatory query boolean false Mandatory subscription filter
status query LifeCycleStatus false Subscription status filter
activation_date query DateFilterEnum false Subscriptions activated matching date filter. Available filters are [eq, lt, lte, gt, gte]. Format
according to ISO 8601
deactivation_date query DateFilterEnum false Active subscription or deactivated matching date filter. Available filters are [eq, lt, lte, gt, gte].
Format according to ISO 8601

Enumerated Values

Property Values
status one of [REQUESTED, ON_HOLD, PROVISIONING, ACTIVE, DEACTIVATING, DEACTIVATED, CANCELLING, CANCELLED]

Request example

1
2
3
4
5


curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/broadband?legacy_id='26245435'&legacy_account_id='572234234'&legacy_service_id='MYSIM_9395450'&legacy_bundle_id='26245435'&mandatory='true'&status='ACTIVE'&activation_date='2023-01-05T03:30:15Z'&deactivation_date='2023-01-05T03:30:15Z' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK BroadbandSet
403 Forbidden Forbidden access ErrorResponse
500 Internal Server Error Internal server error ErrorResponse
default Default Any client or server error ErrorResponse

Parameters

Name In Type Required Description
org path string true Organization name
id path string true Subscription unique identifier

Request example

1
2
3
4
5


curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/broadband/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK Broadband
403 Forbidden Forbidden access ErrorResponse
404 Not Found A subscription with the specified id was not found ErrorResponse
500 Internal Server Error Internal server error ErrorResponse
default Default Any client or server error ErrorResponse

Endpoints

Subscriptions

    Bundles

      Promotions

        Devices

          AddOns

            Amazon Prime

              Max

                Mobile

                  Broadband

                    Landline

                      Orange TV

                        Orange TV Libre

                          Disney

                            Netflix

                              Credit Limits

                                Change Requests

                                  Commitments