Mobile portabilities

Get portabilities info

Returns a list of portabilities

GET /orgs/{orgs}/portabilities

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant
filter	query	string	false	Add filter to get portabilites

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/portabilities?filter='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	[Portability]
401	Unauthorized	Unauthorized	None
500	Internal Server Error	Internal Server Error	None

200 - instance of Portability

Custom schema example

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


[
  {
    "access_type": "string",
    "cause_status": "string",
    "contract_code": "string",
    "create_date_nc": "string",
    "donor_operator": "string",
    "external_reference": "string",
    "icc_id": "string",
    "id": "string",
    "message_type": "string",
    "msisdn": "string",
    "nrn_receptor": "string",
    "process_id": "string",
    "recipient_operator": "string",
    "recipient_rol": true,
    "state": "string",
    "tenant": "string",
    "window_date": "string"
  }
]

Name	Type	Required	Description
access_type	string	false	none
cause_status	string	false	none
contract_code	string	false	none
create_date_nc	string	false	none
donor_operator	string	false	none
external_reference	string	false	none
icc_id	string	false	none
id	string	false	none
message_type	string	false	none
msisdn	string	false	none
nrn_receptor	string	false	none
process_id	string	false	none
recipient_operator	string	false	none
recipient_rol	boolean	false	none
state	string	false	none
tenant	string	false	none
window_date	string	false	none

Get portabilities by processId

Returns a list of portabilities filter by processId

GET /orgs/{orgs}/portabilities/processId/{processId}

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant
processId	path	string	true	ProcessId
filter	query	string	false	Add filter to get portabilites

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/portabilities/processId/{processId}?filter='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	[Portability]
401	Unauthorized	Unauthorized	None
500	Internal Server Error	Internal Server Error	None

200 - instance of Portability

Custom schema example

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


[
  {
    "access_type": "string",
    "cause_status": "string",
    "contract_code": "string",
    "create_date_nc": "string",
    "donor_operator": "string",
    "external_reference": "string",
    "icc_id": "string",
    "id": "string",
    "message_type": "string",
    "msisdn": "string",
    "nrn_receptor": "string",
    "process_id": "string",
    "recipient_operator": "string",
    "recipient_rol": true,
    "state": "string",
    "tenant": "string",
    "window_date": "string"
  }
]

Name	Type	Required	Description
access_type	string	false	none
cause_status	string	false	none
contract_code	string	false	none
create_date_nc	string	false	none
donor_operator	string	false	none
external_reference	string	false	none
icc_id	string	false	none
id	string	false	none
message_type	string	false	none
msisdn	string	false	none
nrn_receptor	string	false	none
process_id	string	false	none
recipient_operator	string	false	none
recipient_rol	boolean	false	none
state	string	false	none
tenant	string	false	none
window_date	string	false	none

Get portabilities by msisdn

Returns a list of portabilities filter by msisdn

GET /orgs/{orgs}/portabilities/msisdn/{msisdn}

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant
msisdn	path	string	true	Msisdn
filter	query	string	false	Add filter to get portabilites

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/portabilities/msisdn/{msisdn}?filter='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	[Portability]
401	Unauthorized	Unauthorized	None
500	Internal Server Error	Internal Server Error	None

200 - instance of Portability

Custom schema example

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


[
  {
    "access_type": "string",
    "cause_status": "string",
    "contract_code": "string",
    "create_date_nc": "string",
    "donor_operator": "string",
    "external_reference": "string",
    "icc_id": "string",
    "id": "string",
    "message_type": "string",
    "msisdn": "string",
    "nrn_receptor": "string",
    "process_id": "string",
    "recipient_operator": "string",
    "recipient_rol": true,
    "state": "string",
    "tenant": "string",
    "window_date": "string"
  }
]

Name	Type	Required	Description
access_type	string	false	none
cause_status	string	false	none
contract_code	string	false	none
create_date_nc	string	false	none
donor_operator	string	false	none
external_reference	string	false	none
icc_id	string	false	none
id	string	false	none
message_type	string	false	none
msisdn	string	false	none
nrn_receptor	string	false	none
process_id	string	false	none
recipient_operator	string	false	none
recipient_rol	boolean	false	none
state	string	false	none
tenant	string	false	none
window_date	string	false	none

Get last portabilities by msisdn

Returns last portability from a msisdn

GET /orgs/{orgs}/portabilities/msisdn/{msisdn}/last

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant
msisdn	path	string	true	Msisdn
filter	query	string	false	Add filter to get portabilites

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/portabilities/msisdn/{msisdn}/last?filter='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	[Portability]
401	Unauthorized	Unauthorized	None
500	Internal Server Error	Internal Server Error	None

200 - instance of Portability

Custom schema example

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


[
  {
    "access_type": "string",
    "cause_status": "string",
    "contract_code": "string",
    "create_date_nc": "string",
    "donor_operator": "string",
    "external_reference": "string",
    "icc_id": "string",
    "id": "string",
    "message_type": "string",
    "msisdn": "string",
    "nrn_receptor": "string",
    "process_id": "string",
    "recipient_operator": "string",
    "recipient_rol": true,
    "state": "string",
    "tenant": "string",
    "window_date": "string"
  }
]

Name	Type	Required	Description
access_type	string	false	none
cause_status	string	false	none
contract_code	string	false	none
create_date_nc	string	false	none
donor_operator	string	false	none
external_reference	string	false	none
icc_id	string	false	none
id	string	false	none
message_type	string	false	none
msisdn	string	false	none
nrn_receptor	string	false	none
process_id	string	false	none
recipient_operator	string	false	none
recipient_rol	boolean	false	none
state	string	false	none
tenant	string	false	none
window_date	string	false	none

Get portabilities by id

Returns a portability

GET /orgs/{orgs}/portabilities/id/{id}

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant
id	path	string	true	id

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/portabilities/id/{id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	PortabilityDetail
401	Unauthorized	Unauthorized	None
500	Internal Server Error	Internal Server Error	None

Get pending donor portabilities

Returns a list of portability pending response

GET /orgs/{orgs}/portabilities/pendingDonor

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/portabilities/pendingDonor \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Portability
401	Unauthorized	Unauthorized	None
500	Internal Server Error	Internal Server Error	None

Get filtered info for operators in Central Node

Returns the filtered info saved from operators in Central Node

GET /orgs/{orgs}/operator

Parameters

Name	In	Type	Required	Description
orgs	path	string	true	Tenant
operator	query	string	false	Operator
operatorCode	query	string	false	Operator code
status	query	string	false	Operator status

Request example

1
2
3
4



curl -X GET https://mas-portability.sta.masstack.com/v1/orgs/{orgs}/operator?operator='string'&operatorCode='string'&status='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	[OperatorConfigs]
404	Not Found	Not Found	None
500	Internal Server Error	Internal Server Error	None

200 - instance of OperatorConfigs

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30


[
  [
    {
      "id": 4,
      "operator": "YOIGO",
      "operator_code": "005",
      "nrn_range": [
        {
          "id": 0,
          "initial_nrn": 900053,
          "final_nrn": 900056
        }
      ],
      "network_operator": "003",
      "msisdn_range": [
        {
          "id": 0,
          "initial_msisdn": 600000000,
          "final_msisdn": 600000001
        }
      ],
      "individual_quota": "A",
      "multiple_quota": 50,
      "change_quota": 1000,
      "status": "ACTIVO",
      "status_date": "2024-01-30T10:00:00Z",
      "backup": false
    }
  ]
]

Name	Type	Required	Description
anonymous	[OperatorConfig]	false	none