masstack

V1
V1-sales
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
org path string true Organization name
bundleId path string(uuid) true Bundle identifier
offset query integer false Pagination offset
limit query integer false Pagination limit
legacy_id query integer false Resource legacy ID
legacy_account_id query integer false Account id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_bundle_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
legacy_bundle_id query integer false Bundle id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_account_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
account_id query string false Account id the subscription is linked to. Required if ‘legacy_id’, ‘legacy_account_id’ or legacy_bundle_id filters are not provided.
mandatory query boolean false Mandatory subscription filter
status query SubscriptionStatusFilterEnum false Subscription status filter
type query SubscriptionType false Subscription type
activation_date query DateFilterEnum false Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
deactivation_date query DateFilterEnum false Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
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

Request example

1
2
3
4
5


curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/bundles/7a15e304-c357-449b-bd58-bcfb43b3471d/subscriptions/broadband?offset='0'&limit='50'&legacy_id='0'&legacy_account_id='572234234'&legacy_bundle_id='26245435'&account_id='ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'&mandatory='true'&status={"eq":"ACTIVE","in":["ACTIVE"]}&type='NETFLIX'&activation_date='2023-01-05T03:30:15Z'&deactivation_date='2023-01-05T03:30:15Z'&legacy_service_id='MYSIM_9395450' \
  -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
offset query integer false Pagination offset
limit query integer false Pagination limit
legacy_id query integer false Resource legacy ID
legacy_account_id query integer false Account id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_bundle_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
legacy_bundle_id query integer false Bundle id the subscription is linked to. Required if ‘legacy_id’, ‘account_id’ or legacy_account_id filter are not provided. Linked to MySim/Apollo storage, to be deprecated.
account_id query string false Account id the subscription is linked to. Required if ‘legacy_id’, ‘legacy_account_id’ or legacy_bundle_id filters are not provided.
mandatory query boolean false Mandatory subscription filter
status query SubscriptionStatusFilterEnum false Subscription status filter
type query SubscriptionType false Subscription type
activation_date query DateFilterEnum false Resource activation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
deactivation_date query DateFilterEnum false Resource deactivation date filter. Available filters are [eq, lt, lte, gt, gte]. Format according to ISO 8601
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

Request example

1
2
3
4
5


curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/broadband?offset='0'&limit='50'&legacy_id='0'&legacy_account_id='572234234'&legacy_bundle_id='26245435'&account_id='ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39'&mandatory='true'&status={"eq":"ACTIVE","in":["ACTIVE"]}&type='NETFLIX'&activation_date='2023-01-05T03:30:15Z'&deactivation_date='2023-01-05T03:30:15Z'&legacy_service_id='MYSIM_9395450' \
  -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
subscriptionId path string(uuid) 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

                                    DeviceInsurance

                                      Multisim

                                        Payment Plans

                                          Operations