Masks

Get barring masks catalogue

Gets the barring masks catalogue

GET /orgs/{orgId}/masks

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
operationTypeCode	query	string	false	The operation type code of the mask
code	query	string	false	The name code of the mask
subscriptionType	query	string	false	The subscription type code of the mask

Request example

1
2
3
4



curl -X GET https://barrings.masstack.com/v3/orgs/masmovil/masks?operationTypeCode='DEBT'&code='DEBT_MOBILE_HOTLP'&subscriptionType='MOBILE' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully returned the barring mask catalogue	[MaskCatalogueDto]
400	Bad Request	Bad Request	ErrorResponse
401	Unauthorized	Unauthorized request	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
500	Internal Server Error	Internal Server Error	ErrorResponse

Get mask by id

Return a mask if exists

GET /orgs/{orgId}/masks/{maskId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
maskId	path	integer(int64)	true	Mask Id

Request example

1
2
3
4



curl -X GET https://barrings.masstack.com/v3/orgs/masmovil/masks/1 \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	The mask	MaskCatalogueDto
400	Bad Request	Bad Request	ErrorResponse
404	Not Found	Not Found	ErrorResponse
500	Internal Server Error	Unexpected error	ErrorResponse

Get masks applied to a subscription

GET /orgs/{orgId}/subscriptions/{subscriptionId}/masks

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
subscriptionId	path	string	true	Subscription identifier

Request example

1
2
3
4



curl -X GET https://barrings.masstack.com/v3/orgs/masmovil/subscriptions/22222/masks \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully returned the masks associated to a subscription.	[MaskCode]
400	Bad Request	Bad Request	ErrorResponse
401	Unauthorized	Unauthorized request	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
500	Internal Server Error	Internal Server Error	ErrorResponse

Patch for apply or remove masks

Request a barring masks set operation over a subscription.

PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/masks

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
subscriptionId	path	string	true	Subscription identifier
body	body	MasksOperationRequest	true	Contains the operation and the masks code set, that contains the barrings masks to operate over a subscription

Request body - instance of MasksOperationRequest

1
2
3
4
5
6
7


{
  "action": "APPLY",
  "barringsMasksCodes": [
    "string"
  ],
  "reason": "MIGRATION"
}

Name	Type	Required	Description
action	string	true	Action of the operation, the operation that applies the set of masks provided
barringsMasksCodes	[string]	true	none
reason	string	false	Reason of barring operation

Property	Values
action	one of [APPLY, REMOVE]
reason	one of [DEBT, RISK, MIGRATION, ATC, CUST]

Request example

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



curl -X PATCH https://barrings.masstack.com/v3/orgs/masmovil/subscriptions/22222/masks \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'action': 'APPLY',
  'barringsMasksCodes': [
    'string'
  ],
  'reason': 'MIGRATION'
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	Successfully accepted the operation request, returned the evaluation of mask, network services new status application pending	MasksOperationResponse
400	Bad Request	Bad Request	ErrorResponse
401	Unauthorized	Unauthorized request	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	SubscriptionId not found	ErrorResponse
409	Conflict	Conflict to apply or remove barrings with subscription with invalid status	ErrorResponse
500	Internal Server Error	Internal Server Error	ErrorResponse

Get deferred masks that will be applied to a subscription

GET /orgs/{orgId}/subscriptions/{subscriptionId}/masks/deferred

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
subscriptionId	path	string	true	Subscription identifier

Request example

1
2
3
4



curl -X GET https://barrings.masstack.com/v3/orgs/masmovil/subscriptions/22222/masks/deferred \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully returned the deferred masks that will be applied to the subscription.	[DeferredMask]
400	Bad Request	Bad Request	ErrorResponse
401	Unauthorized	Unauthorized request	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
500	Internal Server Error	Internal Server Error	ErrorResponse

Patch for apply or remove masks for prepaid subscriptions

Request a barring masks set operation over a prepaid subscription.

PATCH /orgs/{orgId}/subscriptions/{subscriptionId}/masks/prepaid

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
subscriptionId	path	string	true	Subscription identifier
body	body	MasksPrepaidOperationRequest	true	Contains the operation and the masks code set, that contains the barrings masks to operate over a prepaid subscription

Request body - instance of MasksPrepaidOperationRequest

1
2
3
4
5
6
7
8


{
  "action": "APPLY",
  "barringsMasksCodes": [
    "string"
  ],
  "reason": "MIGRATION",
  "deferredDate": "2025-02-01T09:00:00Z"
}

Name	Type	Required	Description
action	string	true	Action of the operation, the operation that applies the set of masks provided
barringsMasksCodes	[string]	true	none
reason	string	false	Reason of barring operation
deferredDate	string(date-time)	false	Date when the barring will be applied

Property	Values
action	one of [APPLY, REMOVE]
reason	one of [DEBT, RISK, MIGRATION, ATC, CUST]

Request example

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



curl -X PATCH https://barrings.masstack.com/v3/orgs/masmovil/subscriptions/22222/masks/prepaid \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'action': 'APPLY',
  'barringsMasksCodes': [
    'string'
  ],
  'reason': 'MIGRATION',
  'deferredDate': '2025-02-01T09:00:00Z'
}" 

Responses

Code	Meaning	Description	Schema
202	Accepted	Successfully accepted the operation request, returned the evaluation of mask, network services new status application pending	MasksOperationResponse
400	Bad Request	Bad Request	ErrorResponse
401	Unauthorized	Unauthorized request	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	SubscriptionId not found	ErrorResponse
409	Conflict	Conflict to apply or remove barrings with subscription with invalid status	ErrorResponse
500	Internal Server Error	Internal Server Error	ErrorResponse

Get masks applied history to a subscription

Return a history list of of barred masks

GET /orgs/{orgId}/subscriptions/{subscriptionId}/masks/history

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	A masmovil tenant
subscriptionId	path	string	true	Subscription identifier

Request example

1
2
3
4



curl -X GET https://barrings.masstack.com/v3/orgs/masmovil/subscriptions/22222/masks/history \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	History list of masks	[MaskHistoryResponse]
400	Bad Request	Bad Request	ErrorResponse
500	Internal Server Error	Unexpected error	ErrorResponse