masstack

V2
V3
V4
API Overview Resources Schemas

Barrings

Proxy to selfCareSocket blocks

Parameters

Name In Type Required Description
orgId path string true organization name
subscriptionId path integer(int64) true subscription identifier

Request example

1
2
3
4
5


curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/subscriptions/214748364/blocks \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation SubscriptionBlocks
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 SubscriptionBlocks

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "subscription_id": 0,
  "items": [
    {
      "id": 214748364,
      "value": "ROBO",
      "date_last_modified": "2017-09-15T22:00:00Z",
      "description": "A PETICION DE CLIENTE"
    }
  ]
}
Name Type Required Description
subscription_id integer(int64) false identification subscription
items [Block] false none

Parameters

Name In Type Required Description
orgId path string true organization name
subscriptionId path integer(int64) true subscription identifier
blockId path integer(int32) true block identifier (only allow 1 or 2)
body body BlockStatus true Change block status

Request body - instance of BlockStatus

1
2
3
4

{
  "active": true,
  "reason": "Lo ha perdido"
}
Name Type Required Description
active boolean true active = True - Activate a service
active = False - Deactivate a service
reason string false Describes the reason to block the simcard

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


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

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

                            Consumption

                              Workorders

                                Penalties