masstack

V2
V3
V4
API Overview Resources Schemas

Services

Access to services

Parameters

Name In Type Required Description
orgId path string true organization name
subscriptionId path integer(int64) true subscription identifier
query query Query false User ‘filter’ to get ‘active’ or ‘inactive’ services

Request example

1
2
3
4
5


curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/services?query={"filter":["string"],"include":["string"]} \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation SubscriptionServices
400 Bad Request Invalid request body ErrorMessage
404 Not Found Resource not found ErrorMessage
405 Method Not Allowed Method not allowed None

200 - instance of SubscriptionServices

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "subscription_id": 0,
  "items": [
    {
      "id": 214748364,
      "value": "VOZ",
      "changeable": true,
      "date_last_modified": "2017-09-15T22:00:00Z",
      "active": true
    }
  ]
}
Name Type Required Description
subscription_id integer(int64) false identification subscription
items [Service] false none

Parameters

Name In Type Required Description
orgId path string true organization name
subscriptionId path integer(int64) true subscription identifier
serviceId path integer(int64) true service identifier
body body ServiceStatus true Change service status

Request body - instance of ServiceStatus

1
2
3

{
  "active": true
}
Name Type Required Description
active boolean false active = True - Activate a service
active = False - Deactivate a service

Request example

1
2
3
4
5
6
7
8
9


curl -X PATCH https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/services/214748364 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'active': true
}"

Responses

Code Meaning Description Schema
201 Created successful operation None
400 Bad Request Invalid request body ErrorMessage
404 Not Found Resource not found ErrorMessage
405 Method Not Allowed Method not allowed None

400 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6

{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}
Name Type Required Description
code integer(int32) false Custom error code
status string false Status
message string false Status message
detailMsg string false Detailed description of the error

Endpoints

Signups

    Users

      Accounts

        Invoices

          Terms

            Payment info

              Account migrations

                Subscriptions

                  Products

                    Services

                      Bonuses

                        Promotions

                          Barrings

                            Workorders

                              Penalties