masstack

V3
API Overview Resources Schemas

Promotions 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
body body createPromotionRequestDTO true Contain promotion information to be activated

Enumerated Values

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

Request body - instance of createPromotionRequestDTO

1
2
3
4
5
6
7

{
  "promotion": {
    "promotion_id": 76,
    "activation_date": "2017-09-15T22:00:00Z",
    "deactivation_date": "2017-09-15T22:00:00Z"
  }
}
Name Type Required Description
promotion promotionDTO true none

Request example

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


curl -X POST https://partners.sta.masstack.com/v3/mobile/612123456/promotions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'promotion': {
    'promotion_id': 76,
    'activation_date': '2017-09-15T22:00:00Z',
    'deactivation_date': '2017-09-15T22:00:00Z'
  }
}"

Responses

Code Meaning Description Schema
201 Created Successfully created the operation request, returned the result PromotionSuccessResponseDTO
400 Bad Request Bad Request genericErrorResponseDTO
401 Unauthorized Unauthorized request genericErrorResponseDTO
403 Forbidden Forbidden resource genericErrorResponseDTO
404 Not Found Not found genericErrorResponseDTO
406 Not Acceptable Not Acceptable genericErrorResponseDTO
500 Internal Server Error Internal Server Error genericErrorResponseDTO

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
promotion_id path string true Promotion identifier
body body updatePromotionRequestDTO true Update an existing promotion

Enumerated Values

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

Request body - instance of updatePromotionRequestDTO

1
2
3

{
  "deactivation_date": "2022-02-24T13:45:10Z"
}
Name Type Required Description
deactivation_date string(date-time) true none

Request example

1
2
3
4
5
6
7
8
9


curl -X PATCH https://partners.sta.masstack.com/v3/mobile/612123456/promotions/612123456 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'deactivation_date': '2022-02-24T13:45:10Z'
}"

Responses

Code Meaning Description Schema
200 OK Successfully completed the operation request, returned the result promotionUpdateResponseDTO
400 Bad Request Bad Request genericErrorResponseDTO
401 Unauthorized Unauthorized request genericErrorResponseDTO
403 Forbidden Forbidden resource genericErrorResponseDTO
404 Not Found Not found genericErrorResponseDTO
406 Not Acceptable Not Acceptable genericErrorResponseDTO
500 Internal Server Error Internal Server Error genericErrorResponseDTO

Endpoints

Barrings Operations

    Billing Operations

      Promotions Operations

        Service Operations