API Overview Resources Schemas

Schemas

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]

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]

MasksOperationResponse

1
2
3


{
  "externalId": "1234451112-a3a2"
}

Name	Type	Required	Description
externalId	string	true	External identifier of the business process operation triggered and associated to the request

ServiceOperationRequest

1
2
3
4


{
  "reason": "CUST",
  "active": true
}

Name	Type	Required	Description
reason	string	true	Reason
active	boolean	true	none

Property	Values
reason	one of [CUST, PROD]

MultiServicesOperationRequest

1
2
3
4
5
6
7
8
9


{
  "reason": "CUST",
  "services": [
    {
      "serviceId": 10,
      "active": true
    }
  ]
}

Name	Type	Required	Description
reason	string	true	Reason
services	[ServiceDto]	true	[Service with status]

Property	Values
reason	one of [CUST, PROD]

ServiceOperationResponse

1
2
3


{
  "externalId": "1234451112-a3a2"
}

Name	Type	Required	Description
externalId	string	true	External identifier of the business process operation triggered and associated to the request

ServiceDto

1
2
3
4


{
  "serviceId": 10,
  "active": true
}

Name	Type	Required	Description
serviceId	integer(int64)	true	Service Id
active	boolean	true	Desired service status

ServiceStatusDto

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


{
  "serviceId": 1111,
  "serviceName": "OUTGOING_VOICE",
  "active": true,
  "statusReason": [
    "string"
  ],
  "order": {
    "running": true,
    "orders": [
      "string"
    ]
  }
}

Name	Type	Required	Description
serviceId	integer(int64)	true	Service Id
serviceName	string	true	Service Name
active	boolean	true	Service status
statusReason	[string]	true	none
order	OrderDto	true	none

OrderDto

1
2
3
4
5
6


{
  "running": true,
  "orders": [
    "string"
  ]
}

Name	Type	Required	Description
running	boolean	true	Order running status
orders	[string]	true	External id list

ServiceStatusListDto

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


[
  {
    "serviceId": 1111,
    "serviceName": "OUTGOING_VOICE",
    "active": true,
    "statusReason": [
      "string"
    ],
    "order": {
      "running": true,
      "orders": [
        "string"
      ]
    }
  }
]

Name	Type	Required	Description
anonymous	[ServiceStatusDto]	false	none

SubscriptionMasksResponse

1
2
3


[
  "DEBT_MOBILE_LP"
]

Name	Type	Required	Description
anonymous	[MaskCode]	false	Mask code list

MaskCode

1

"DEBT_MOBILE_LP"

Name	Type	Required	Description
anonymous	string	false	Mask code

SubscriptionDeferredMasksResponse

1
2
3
4
5
6


[
  {
    "mask": "CUST_ORANGETV_RESTRICTED",
    "deferredDate": "2025-02-01T09:00:00Z"
  }
]

Name	Type	Required	Description
anonymous	[DeferredMask]	false	Deferred Masks list

DeferredMask

1
2
3
4


{
  "mask": "CUST_ORANGETV_RESTRICTED",
  "deferredDate": "2025-02-01T09:00:00Z"
}

Name	Type	Required	Description
mask	string	true	none
deferredDate	string(date-time)	true	none

SubscriptionMasksHistoryResponse

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


[
  {
    "id": 1,
    "mask": {
      "id": 14,
      "code": "DEBT_MOBILE_RESTRICTED",
      "name": "Restringido",
      "description": "DEBT_MOBILE_RESTRICTED description"
    },
    "operation": "APPLY",
    "subscription_id": 14,
    "user": "MB_username",
    "date": "2019-08-24T14:15:22Z"
  }
]

Name	Type	Required	Description
anonymous	[MaskHistoryResponse]	false	none

MaskHistoryResponse

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


{
  "id": 1,
  "mask": {
    "id": 14,
    "code": "DEBT_MOBILE_RESTRICTED",
    "name": "Restringido",
    "description": "DEBT_MOBILE_RESTRICTED description"
  },
  "operation": "APPLY",
  "subscription_id": 14,
  "user": "MB_username",
  "date": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Description
id	integer(int64)	true	history id
mask	ReducedMaskDto	true	none
operation	string	true	none
subscription_id	string	true	subscription id
user	string	true	none
date	string(date-time)	true	none

Property	Values
operation	one of [APPLY, REMOVE]

UploadFileResponse

1
2
3
4


{
  "fileName": "regularization_data.csv",
  "message": "File uploaded successfully."
}

Name	Type	Required	Description
fileName	string	false	The name of the file that was uploaded.
message	string	false	A confirmation message indicating the status of the upload.

ReducedMaskDto

1
2
3
4
5
6


{
  "id": 14,
  "code": "DEBT_MOBILE_RESTRICTED",
  "name": "Restringido",
  "description": "DEBT_MOBILE_RESTRICTED description"
}

Name	Type	Required	Description
id	integer(int64)	true	The mask id
code	string	true	Then mask code
name	string	true	none
description	string	true	Then mask description

MaskCatalogueListDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


[
  {
    "id": 10,
    "code": "DEBT_MOBILE_LP",
    "description": "Line services suspension due to debt",
    "name": "Redireccion Internet",
    "operationTypeCode": "DEBT",
    "subscriptionTypeCode": "MOBILE",
    "services": [
      {
        "id": 10,
        "code": "OUTGOING_VOICE",
        "description": "Outgoing Voice"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	[MaskCatalogueDto]	false	List of barring masks

MaskCatalogueDto

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


{
  "id": 10,
  "code": "DEBT_MOBILE_LP",
  "description": "Line services suspension due to debt",
  "name": "Redireccion Internet",
  "operationTypeCode": "DEBT",
  "subscriptionTypeCode": "MOBILE",
  "services": [
    {
      "id": 10,
      "code": "OUTGOING_VOICE",
      "description": "Outgoing Voice"
    }
  ]
}

Name	Type	Required	Description
id	integer(int64)	true	Mask Id
code	string	true	Barrings mask code, external identifier
description	string	false	Barrings mask description
name	string	false	Barrings mask business name
operationTypeCode	string	false	Operation type group code
subscriptionTypeCode	string	false	Subscription type code
services	ServiceCatalogueListDto	false	List of mask services

ServiceCatalogueListDto

1
2
3
4
5
6
7


[
  {
    "id": 10,
    "code": "OUTGOING_VOICE",
    "description": "Outgoing Voice"
  }
]

Name	Type	Required	Description
anonymous	[ServiceCatalogueDto]	false	none

ServiceCatalogueDto

1
2
3
4
5


{
  "id": 10,
  "code": "OUTGOING_VOICE",
  "description": "Outgoing Voice"
}

Name	Type	Required	Description
id	integer(int64)	true	Service Id
code	string	true	Service code
description	string	false	Service description

ServiceStatusHistoryListResponse

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


[
  {
    "id": 1,
    "subscriptionId": 14,
    "serviceId": 1,
    "serviceName": "ROAMING",
    "serviceStatus": true,
    "operationTypeId": 1,
    "operationType": "CUST",
    "username": "barrings",
    "updateDate": "2024-11-19T09:34:10Z"
  }
]

Name	Type	Required	Description
anonymous	[ServiceStatusHistoryResponse]	false	none

ServiceStatusHistoryResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "id": 1,
  "subscriptionId": 14,
  "serviceId": 1,
  "serviceName": "ROAMING",
  "serviceStatus": true,
  "operationTypeId": 1,
  "operationType": "CUST",
  "username": "barrings",
  "updateDate": "2024-11-19T09:34:10Z"
}

Name	Type	Required	Description
id	integer(int64)	true	The history id
subscriptionId	string	true	The subscription id
serviceId	integer(int64)	true	The service id
serviceName	string	true	The service name
serviceStatus	boolean	true	The service status (true = active, false = inactive)
operationTypeId	integer(int64)	true	The operation type id
operationType	string	true	The operation type code
username	string	true	The username
updateDate	string(date-time)	true	The update date

RegularizationListDto

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


[
  {
    "id": 44444,
    "username": "MB_admin",
    "userReason": "Remove debt from subscriptions",
    "requestDate": "2024-11-19T09:34:10Z",
    "fileName": "debt-2025-06.csv",
    "status": 1,
    "requestedQuantity": 321,
    "requestedCompleted": 321,
    "requestedError": 321,
    "requestedUnprocessed": 321
  }
]

Name	Type	Required	Description
anonymous	[RegularizationDto]	false	none

RegularizationItemListDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


[
  {
    "id": 44444,
    "tenant": "yoigo",
    "subscriptionId": 44444,
    "status": 1,
    "operation": "APPLY",
    "masks": "DEBT_MOBILE_HOTLP,DEBT_MOBILE_RESTRICTED",
    "subscriptionType": "MOBILE"
  }
]

Name	Type	Required	Description
anonymous	[RegularizationItemDto]	false	none

RegularizationDto

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


{
  "id": 44444,
  "username": "MB_admin",
  "userReason": "Remove debt from subscriptions",
  "requestDate": "2024-11-19T09:34:10Z",
  "fileName": "debt-2025-06.csv",
  "status": 1,
  "requestedQuantity": 321,
  "requestedCompleted": 321,
  "requestedError": 321,
  "requestedUnprocessed": 321
}

Name	Type	Required	Description
id	string	false	The regularization id
username	string	true	User who performs the regularization
userReason	string	true	Reason to perform the regularization
requestDate	string(date-time)	true	The date of the regularization
fileName	string	true	Name of the csv file related to the regularization
status	integer(int64)	false	The regularization status
requestedQuantity	integer(int64)	false	The quantity of subscriptions (lines of the csv) to regularize
requestedCompleted	integer(int64)	false	The quantity of subscriptions (lines of the csv) regularized ok
requestedError	integer(int64)	false	The quantity of subscriptions (lines of the csv) regularized ko
requestedUnprocessed	integer(int64)	false	The quantity of subscriptions (lines of the csv) unprocessed

RegularizationItemDto

1
2
3
4
5
6
7
8
9


{
  "id": 44444,
  "tenant": "yoigo",
  "subscriptionId": 44444,
  "status": 1,
  "operation": "APPLY",
  "masks": "DEBT_MOBILE_HOTLP,DEBT_MOBILE_RESTRICTED",
  "subscriptionType": "MOBILE"
}

Name	Type	Required	Description
id	string	false	The regularization item id
tenant	string	true	The subscription tenant
subscriptionId	string	true	The subscription id
status	integer(int64)	true	The regularization item status
operation	string	true	The operation to perform
masks	string	true	A comma separated list of mask to operate
subscriptionType	string	false	The subscription type

ErrorResponse

1
2
3
4
5


{
  "tracingId": "0e3f7e20-6a4b-4344-bad0-fe8576e72adc",
  "code": "INVALID_BARRING_MASK",
  "message": "OA3_400_01: Validation error in some parameters. See swagger documentation"
}

Name	Type	Required	Description
tracingId	string	true	Trace id of the related request to track the exception
code	string	true	Error code string for fast identification
message	string	false	Message description or detail of error