Coverage management

get__orgs_{orgId}_management_address_{address_id}_territory_owner

Return territory_owners related to address_id. Could be more than one. Must select the territory with more priotity.

GET /orgs/{orgId}/management/address/{address_id}/territory_owner

Parameters {id=“get__orgs_{orgid}_management_address_{address_id}_territory_owner-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
address_id	path	string	true	address_id with or without spaces
business_rules	query	boolean	false	If true, iam business rules are applied to the response. Otherwise, the response includes all TOs found, if any.
sf-channel	header	string	true	Must be provide by feasibility squad
sf-segment	header	string	true	Must be provide by feasibility squad
sf-check-id	header	string(uuid)	true	Must use a UUID format

Request example

1
2
3
4
5
6
7



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/address/J0000000000000000000000000000003728533/territory_owner?business_rules='true' \
  -H "Accept: application/json" \
  -H "sf-channel: string" \
  -H "sf-segment: string" \
  -H "sf-check-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses {id=“get__orgs_{orgid}_management_address_{address_id}_territory_owner-response”}

Code	Meaning	Description	Schema
200	OK	search results matching criteria	address_id_response
400	Bad Request	Bad request	error_response
404	Not Found	bad input parameter	None

get__orgs_{orgId}_management_blacklist_reasons

Returns a json array of blacklist reasons available for the given user role.

GET /orgs/{orgId}/management/blacklist/reasons

Parameters {id=“get__orgs_{orgid}_management_blacklist_reasons-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack

Request example

1
2
3
4



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/blacklist/reasons \
  -H "Accept: application/json"

Responses {id=“get__orgs_{orgid}_management_blacklist_reasons-response”}

Code	Meaning	Description	Schema
200	OK	A list of blacklist reasons for the user auth roles	[blacklist_reason]

200 - instance of blacklist_reason

Custom schema example

1
2
3
4
5
6
7
8


[
  {
    "reason": "string",
    "reason_type": "string",
    "reason_code": "string",
    "duration_days": 0
  }
]

Name	Type	Required	Description
reason	string	false	none
reason_type	string	false	none
reason_code	string	false	none
duration_days	integer(int32)	false	none

get__orgs_{orgId}_management_blacklist_blocks_{id}

Returns a json array of of blocks for a given id

GET /orgs/{orgId}/management/blacklist/blocks/{id}

Parameters {id=“get__orgs_{orgid}_management_blacklist_blocks_{id}-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	path	string	true	gescal 7, gescal 17 o gescal 37

Request example

1
2
3
4



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/blacklist/blocks/8002231318100184 \
  -H "Accept: application/json"

Responses {id=“get__orgs_{orgid}_management_blacklist_blocks_{id}-response”}

Code	Meaning	Description	Schema
200	OK	A list of blocks for the given id	[blacklist_block]
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	[not_found_response]

200 - instance of blacklist_block

Custom schema example

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


[
  {
    "id": 8002231318100184,
    "territory_owners": [
      "ALL",
      "EKNBLC1",
      "EKNEB01",
      "FIBNBLC1",
      "FIBNEB05",
      "MASMOVIL"
    ],
    "gescal_scope": "G17",
    "block_reason": "CANALIZADO EXTERIOR OBSTRUIDO",
    "block_reason_code": "INF_5",
    "block_until": "2023-10-30",
    "block_user": "example@masmovil.com",
    "block_role": "feasibility-blacklist-admin",
    "block_date": "2023-05-03",
    "block_observation": "example observation"
  }
]

Name	Type	Required	Description
id	string	false	none
territory_owners	[string]	false	none
gescal_scope	string	false	none
block_reason	string	false	none
block_reason_code	string	false	none
block_until	string	false	none
block_user	string	false	none
block_role	string	false	none
block_date	string	false	none
block_observation	string	false	none

post__orgs_{orgId}_management_blacklist_building

Blocks the given id, territory owner and reason code.

POST /orgs/{orgId}/management/blacklist/building

Parameters {id=“post__orgs_{orgid}_management_blacklist_building-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	blacklist_post_block	false	Block - The block we want to create: * id - The gescal 17 to block. * reason_code - The code for the reason we want to block the id. * territory_owner - The territory owner we want to block in that building. “ALL” to block all territory owners. * observation - An OPTIONAL 250 max character observation about the block that is being created.

Request body - instance of blacklist_post_block

1
2
3
4
5
6


{
  "id": 8002231318100184,
  "reason_code": "INF_5",
  "territory_owner": "ALL",
  "observation": "example observation"
}

Name	Type	Required	Description
id	string	false	none
reason_code	string	false	none
territory_owner	string	false	none
observation	string	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/blacklist/building \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'id': 8002231318100184,
  'reason_code': 'INF_5',
  'territory_owner': 'ALL',
  'observation': 'example observation'
}" 

Responses {id=“post__orgs_{orgid}_management_blacklist_building-response”}

Code	Meaning	Description	Schema
200	OK	Returns a Json object that describes the newly created block.	Inline
400	Bad Request	Bad request	bad_request_response

200 - JsonObject

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


{
  "valid_fields": {
    "id": "08002231318100184         BA         ",
    "territory_owner": "ALL",
    "block_until": "2023-11-01",
    "reason": "DISTANCIA EXCESIVA",
    "block_user": "example@masmovil.com",
    "block_role": "example-example-example",
    "has_coverage": "EKNEB01"
  },
  "g17_result": [
    {
      "id": 8002231318100184,
      "territory_owner": "ALL",
      "gescal_scope": "G17",
      "block_until": "2023-11-01T00:00",
      "creation_user": "example@masmovil.com"
    }
  ],
  "g37_result": [
    {
      "id": 8002231318100184,
      "territory_owner": "ALL",
      "gescal_scope": "G17",
      "block_until": "2023-11-01T00:00",
      "creation_user": "example@masmovil.com"
    }
  ]
}

None

post__orgs_{orgId}_management_blacklist_unit

Blocks the given id, territory owner and reason code.

POST /orgs/{orgId}/management/blacklist/unit

Parameters {id=“post__orgs_{orgid}_management_blacklist_unit-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	blacklist_post_block	false	Block - The block we want to create: * id - The gescal 37 to block. * reason_code - The code for the reason we want to block the id. * territory_owner - The territory owner we want to block in that building. “ALL” to block all territory owners. * observation - An OPTIONAL 250 max character observation about the block that is being created.

Request body - instance of blacklist_post_block

1
2
3
4
5
6


{
  "id": 8002231318100184,
  "reason_code": "INF_5",
  "territory_owner": "ALL",
  "observation": "example observation"
}

Name	Type	Required	Description
id	string	false	none
reason_code	string	false	none
territory_owner	string	false	none
observation	string	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/blacklist/unit \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'id': 8002231318100184,
  'reason_code': 'INF_5',
  'territory_owner': 'ALL',
  'observation': 'example observation'
}" 

Responses {id=“post__orgs_{orgid}_management_blacklist_unit-response”}

Code	Meaning	Description	Schema
200	OK	Returns a Json object that describes the newly created block.	Inline
400	Bad Request	Bad request	bad_request_response

200 - JsonObject

Custom schema example

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


{
  "valid_fields": {
    "id": "08002231318100184         BA         ",
    "territory_owner": "ALL",
    "block_until": "2023-11-01",
    "reason": "DISTANCIA EXCESIVA",
    "block_user": "example@masmovil.com",
    "block_role": "example-example-example",
    "has_coverage": "EKNEB01"
  },
  "g37_result": [
    {
      "id": 8002231318100184,
      "territory_owner": "ALL",
      "gescal_scope": "G17",
      "block_until": "2023-11-01T00:00",
      "creation_user": "example@masmovil.com"
    }
  ]
}

None

delete__orgs_{orgId}_management_blacklist_building_{id}

Blocks the given id, territory owner and reason code.

DELETE /orgs/{orgId}/management/blacklist/building/{id}

Parameters {id=“delete__orgs_{orgid}_management_blacklist_building_{id}-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	path	string	true	gescal 17 to unblock
territory_owner	query	string	true	territory owner to unblock
reason_code	query	string	true	reason code to unblock
observation	query	string	false	An OPTIONAL observation about the unblock that is being done

Request example

1
2
3
4



curl -X DELETE https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/blacklist/building/{id}?territory_owner='string'&reason_code='string'&observation='string'?territory_owner=string&reason_code=string \
  -H "Accept: application/json"

Responses {id=“delete__orgs_{orgid}_management_blacklist_building_{id}-response”}

Code	Meaning	Description	Schema
200	OK	Returns a Json object that describes all the unblocked gescals	Inline
400	Bad Request	Bad request	bad_request_response

200 - JsonObject

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


{
  "valid_fields": {
    "is_blocked": "MDgwMDIyMzEzMTgxMDAxODQgICAgICAgICBCQSAgICAgICAgIA==",
    "territory_owner": "ALL",
    "unblock_role": "example-example-example"
  },
  "g17_result": [
    {
      "id": 8002231318100184,
      "territory_owner": "ALL",
      "gescal_scope": "G17",
      "block_until": "2023-11-01T00:00",
      "creation_user": "example@masmovil.com"
    }
  ],
  "g37_result": [
    {
      "id": 8002231318100184,
      "territory_owner": "ALL",
      "gescal_scope": "G17",
      "block_until": "2023-11-01T00:00",
      "creation_user": "example@masmovil.com"
    }
  ]
}

None

delete__orgs_{orgId}_management_blacklist_unit_{id}

Blocks the given id, territory owner and reason code.

DELETE /orgs/{orgId}/management/blacklist/unit/{id}

Parameters {id=“delete__orgs_{orgid}_management_blacklist_unit_{id}-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	path	string	true	gescal 37 to unblock
territory_owner	query	string	true	territory owner to unblock
reason_code	query	string	true	reason code to unblock
observation	query	string	false	An OPTIONAL observation about the unblock that is being done

Request example

1
2
3
4



curl -X DELETE https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/blacklist/unit/{id}?territory_owner='string'&reason_code='string'&observation='string'?territory_owner=string&reason_code=string \
  -H "Accept: application/json"

Responses {id=“delete__orgs_{orgid}_management_blacklist_unit_{id}-response”}

Code	Meaning	Description	Schema
200	OK	Returns a Json object that describes all the unblocked gescals	Inline
400	Bad Request	Bad request	bad_request_response

200 - JsonObject

Custom schema example

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


{
  "valid_fields": {
    "is_blocked": "MDgwMDIyMzEzMTgxMDAxODQgICAgICAgICBCQSAgICAgICAgIA==",
    "territory_owner": "ALL",
    "unblock_role": "example-example-example"
  },
  "g37_result": [
    {
      "id": 8002231318100184,
      "territory_owner": "ALL",
      "gescal_scope": "G17",
      "block_until": "2023-11-01T00:00",
      "creation_user": "example@masmovil.com"
    }
  ]
}

None

get__orgs_{orgId}_management_load_info_{id}

Return load info for id

GET /orgs/{orgId}/management/load/info/{id}

Parameters {id=“get__orgs_{orgid}_management_load_info_{id}-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	path	string	true	load id

Request example

1
2
3
4



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/load/info/coverage-load-2023-10-30 \
  -H "Accept: application/json"

Responses {id=“get__orgs_{orgid}_management_load_info_{id}-response”}

Code	Meaning	Description	Schema
200	OK	search results matching criteria	load_info_response
400	Bad Request	Bad request	error_response
404	Not Found	Not found	not_found_response

get__orgs_{orgId}_management_load_history

Return load summary data for loads that started on a date between start_date and end_date

GET /orgs/{orgId}/management/load/history

Parameters {id=“get__orgs_{orgid}_management_load_history-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
start_date	query	string(date)	false	date range start
end_date	query	string(date)	false	date range end
user	query	string	false	user that started the data load
type	query	load_type	false	type of data load
status	query	array[string]	false	array of status a load is in
files	query	string	false	a string to perform a partial search against files loaded. Similar to functions CONTAINS
limit	query	integer	true	max number of items in response
offset	query	integer	true	firs n items to skip in response

Enumerated Values

Property	Values
type	one of [FTTH_COVERAGE, FTTH_COVERAGE_DELTA, BLACKLIST, MAP, HISTORICAL_NAMES, null]
status	one of [DONE, RUNNING, CANCELED, FAILED, PENDING]

Request example

1
2
3
4



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/load/history?start_date='2023-10-01'&end_date='2023-10-30'&user='example@example.com'&type='FTTH_COVERAGE'&status='DONE'&files='HFC'&limit='5'&offset='0'?limit=5&offset=0 \
  -H "Accept: application/json"

Responses {id=“get__orgs_{orgid}_management_load_history-response”}

Code	Meaning	Description	Schema
200	OK	list of data loads matching search criteria	Inline
400	Bad Request	Bad request	error_response

200 - JsonObject

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


{
  "data": [
    {
      "id": "coverage-load-2023-10-30",
      "user": "example@email.com",
      "status": "DONE",
      "load_type": "FTTH_COVERAGE",
      "files": [
        "GIT_107_107_01_231031_01_00073616.csv"
      ],
      "stages": [
        {
          "stage": "PRELOAD",
          "status": "DONE",
          "log": "string",
          "started_at": "2023-10-30 17:15:56",
          "ended_at": "2023-10-30 17:36:22"
        }
      ]
    }
  ],
  "limit": 5,
  "offset": 0,
  "total": 1
}

None

get__orgs_{orgId}_management_load_availabilities

Indicates if load service is available. The service may be processing another data load and thus, not available for a new load.

GET /orgs/{orgId}/management/load/availabilities

Parameters {id=“get__orgs_{orgid}_management_load_availabilities-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
load_type	query	load_type	false	load type to check availability

Enumerated Values

Property	Values
load_type	one of [FTTH_COVERAGE, FTTH_COVERAGE_DELTA, BLACKLIST, MAP, HISTORICAL_NAMES, null]

Request example

1
2
3
4



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/load/availabilities?load_type='FTTH_COVERAGE' \
  -H "Accept: application/json"

Responses {id=“get__orgs_{orgid}_management_load_availabilities-response”}

Code	Meaning	Description	Schema
200	OK	indicates if system is available	[_availability_response_entry]

get__orgs_{orgId}_management_load_availability

Indicates if load service is available. The service amy be processing another data load and thus, not available for a new load.

GET /orgs/{orgId}/management/load/availability

Parameters {id=“get__orgs_{orgid}_management_load_availability-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
load_type	query	load_type	true	load type to check availability

Enumerated Values

Property	Values
load_type	one of [FTTH_COVERAGE, FTTH_COVERAGE_DELTA, BLACKLIST, MAP, HISTORICAL_NAMES, null]

Request example

1
2
3
4



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/load/availability?load_type='FTTH_COVERAGE'?load_type=FTTH_COVERAGE \
  -H "Accept: application/json"

Responses {id=“get__orgs_{orgid}_management_load_availability-response”}

Code	Meaning	Description	Schema
200	OK	indicates if system is available	Inline
400	Bad Request	Bad request	error_response

400 - JsonObject

Custom schema example

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


{
  "availability": false,
  "reason": {
    "id": "coverage-load-2023-10-30",
    "user": "example@email.com",
    "status": "RUNNING",
    "load_type": "FTTH_COVERAGE",
    "files": [
      "GIT_107_107_01_231031_01_00073616.csv"
    ],
    "stages": [
      {
        "stage": "PRELOAD",
        "status": "RUNNING",
        "log": "string",
        "started_at": "2023-10-30 17:15:56"
      }
    ]
  }
}

None

post__orgs_{orgId}_management_load

Creates a new load

POST /orgs/{orgId}/management/load

Parameters {id=“post__orgs_{orgid}_management_load-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	object	true	‘none’

Request body - JsonObject

1

{}

None

Request example

1
2
3
4
5
6
7
8



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/load \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'load_type': 'FTTH_COVERAGE'
}" 

Responses {id=“post__orgs_{orgid}_management_load-response”}

Code	Meaning	Description	Schema
200	OK	indicates if system is available	load_summary
400	Bad Request	Bad request	error_response
409	Conflict	Conflict	error_response
423	Locked	Resource Locked	error_response

post__orgs_{orgId}_management_load_audit_check

Update load audit check stage to DONE, if user wants load to continue or CANCELED if user wants to stop the data load.

POST /orgs/{orgId}/management/load/audit_check

Parameters {id=“post__orgs_{orgid}_management_load_audit_check-parameter”}

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	object	true	‘none’

Request body - JsonObject

1

{}

None

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/masmovil/management/load/audit_check \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'id': 'string',
  'status': 'DONE',
  'night_load': false
}" 

Responses {id=“post__orgs_{orgid}_management_load_audit_check-response”}

Code	Meaning	Description	Schema
200	OK	Response without a content that indcates the operation was successful	None
400	Bad Request	Bad request	error_response
404	Not Found	Not found	not_found_response
409	Conflict	Conflict	error_response