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]

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
4
5
6


{
  "subscriptionId": 1234451113,
  "masks": [
    "DEBT_MOBILE_LP"
  ]
}

Name	Type	Required	Description
subscriptionId	integer(int64)	true	Subscription Id
masks	[string]	true	Mask code list

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	integer(int64)	true	subscription id
user	string	true	none
date	string(date-time)	true	none

Property	Values
operation	one of [APPLY, REMOVE]

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

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