masstack

V3
API Overview Resources Schemas

Barrings Operations

Parameters

Name In Type Required Description
Request-Correlation-Id header string(uuid) false Correlation Id for tracing (unique identifier)
service_type path serviceTypeDTO true Service type indicator
service_id path string true Service identifier whose barring will be updated
body body barringRequestDTO true Contain barring to be updated, the value to be set and the callbacks to be used

Enumerated Values

Property Values
service_type one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of barringRequestDTO

1
2
3
4
5
6

{
  "active": true,
  "barring_name": "ROAMING",
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}
Name Type Required Description
active boolean true none
barring_name string true Name of the barring to be updated
Property Values
barring_name one of [ROAMING, INTERNATIONAL_DESTINATIONS, OUTGOING_VOICE, OUTGOING_SMS, INCOMING_VOICE, INCOMING_SMS, INTERNET, VOICE_PREMIUM_ENTERTAINMENT, VOICE_PREMIUM_INFORMATION, SMS_PREMIUM, SUBSCRIPTION_PREMIUM]

Request example

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


curl -X PATCH https://partners.sta.masstack.com/v3/mobile/612123456/barrings \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'active': true,
  'barring_name': 'ROAMING',
  'callback_success_url': 'https://myserver.com/send/callback/here',
  'callback_error_url': 'https://myserver.com/send/callback/here'
}"

Responses

Code Meaning Description Schema
202 Accepted The operation request was successfully accepted, returned the request external reference identifier None
400 Bad Request Bad Request genericErrorResponseDTO
401 Unauthorized Unauthorized request genericErrorResponseDTO
403 Forbidden Forbidden resource genericErrorResponseDTO
406 Not Acceptable Not Acceptable genericErrorResponseDTO
500 Internal Server Error Internal Server Error genericErrorResponseDTO

success_event

Parameters

Name In Type Required Description
Request-Correlation-Id header string false Workflow Id (unique identifier)
body body barringCallbackDTO true ‘none’

Request body - instance of barringCallbackDTO

1
2
3
4

{
  "codeResult": "OK",
  "titleResult": "Barring update was successfully finished"
}
Name Type Required Description
codeResult string true none
titleResult string true none

Request example

1
2
3
4
5
6
7
8
9


curl -X PATCH https://partners.sta.masstack.com/v3/{service_type}/{service_id}/barrings \
  -H "Content-Type: application/json" \
  -H "Request-Correlation-Id: string" \
 --data-raw "{
  'codeResult': 'OK',
  'titleResult': 'Barring update was successfully finished'
}"

Responses

Code Meaning Description Schema
200 OK OK None
400 Bad Request Not found None
500 Internal Server Error Internal Error None

error_event

Parameters

Name In Type Required Description
Request-Correlation-Id header string false Workflow Id (unique identifier)
body body barringCallbackDTO true ‘none’

Request body - instance of barringCallbackDTO

1
2
3
4

{
  "codeResult": "OK",
  "titleResult": "Barring update was successfully finished"
}
Name Type Required Description
codeResult string true none
titleResult string true none

Request example

1
2
3
4
5
6
7
8
9


curl -X PATCH https://partners.sta.masstack.com/v3/{service_type}/{service_id}/barrings \
  -H "Content-Type: application/json" \
  -H "Request-Correlation-Id: string" \
 --data-raw "{
  'codeResult': 'OK',
  'titleResult': 'Barring update was successfully finished'
}"

Responses

Code Meaning Description Schema
200 OK OK None
400 Bad Request Not found None
500 Internal Server Error Internal Error None

Parameters

Name In Type Required Description
Request-Correlation-Id header string(uuid) false Correlation Id for tracing (unique identifier)
service_type path serviceTypeDTO true Service type indicator
service_id path string true Service identifier whose barring will be updated

Enumerated Values

Property Values
service_type one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request example

1
2
3
4
5


curl -X GET https://partners.sta.masstack.com/v3/mobile/612123456/barrings \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Code Meaning Description Schema
200 OK Successfully getting barring detail barringsDetailResponseDTO
400 Bad Request Bad Request genericErrorResponseDTO
401 Unauthorized Unauthorized request genericErrorResponseDTO
403 Forbidden Forbidden resource genericErrorResponseDTO
406 Not Acceptable Not Acceptable genericErrorResponseDTO
500 Internal Server Error Internal Server Error genericErrorResponseDTO

Endpoints

Barrings Operations

    Billing Operations

      Promotions Operations

        Service Operations