Coverage

getStreets

Returns a list of street summary objects.

GET /orgs/{orgId}/coverage/streets

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
search	query	string	true	search parameter to match in the records (e.g. calle azalea, paseo del prado…)

Request example

1
2
3
4
5
6
7



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

Responses

Code	Meaning	Description	Schema
200	OK	Success	[_street_summary]
400	Bad Request	Bad request	bad_request_response
default	Default	Error	error_response

getBuildings

Returns a list of building summary objects.

GET /orgs/{orgId}/coverage/buildings

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
search	query	string	true	search parameter to match in the records (e.g. calle azalea, madrid, paseo…)

Request example

1
2
3
4
5
6
7



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

Responses

Code	Meaning	Description	Schema
200	OK	Success	[_building_summary]
400	Bad Request	Bad request	bad_request_response
default	Default	Error	error_response

postBuildings

Returns a list of building summary objects.

POST /orgs/{orgId}/coverage/buildings/search

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	_search_params	false	‘none’

Request body - instance of _search_params

1
2
3
4
5
6
7


{
  "way_name": "San Juan",
  "number": "1",
  "way_type": "Paseo",
  "town": "Pedro Andres",
  "postal_code": "02534"
}

Name	Type	Required	Description
way_name	string	true	Way name
number	string	true	Number
way_type	string	false	Way type
town	string	false	Town name
postal_code	string	false	Postal Code

Request example

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



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/masmovil/coverage/buildings/search \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "sf-channel: string" \
  -H "sf-segment: string" \
  -H "sf-check-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'way_name': 'San Juan',
  'number': '1',
  'way_type': 'Paseo',
  'town': 'Pedro Andres',
  'postal_code': '02534'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Success	[_building_summary]
400	Bad Request	Bad request	bad_request_response
default	Default	Error	error_response

getBuildingById

Returns a single building object

GET /orgs/{orgId}/coverage/buildings/{technical_id}

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in masstack
technical_id	path	string	true	Building identifier (Gescal 17)
unit_to_data	query	boolean	false	A boolean to indicate if territory_owner (TO) data is needed for each unit in the unit array response. If True, to arrays will be appended to each unit. A territory_owners array that shows the TOs with coverage in the unit. A blocked_territory_owners array that shows the blocked TOs (ALL if total block)

Request example

1
2
3
4
5
6
7



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/coverage/buildings/{technical_id}?unit_to_data='true' \
  -H "Accept: application/json" \
  -H "sf-channel: string" \
  -H "sf-segment: string" \
  -H "sf-check-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Code	Meaning	Description	Schema
200	OK	Success	_building
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	not_found_response
default	Default	Error	error_response

getBuildingExtraData

Returns an extraData object for a building 'id' and 'territory_owner'.

GET /orgs/{orgId}/coverage/buildings/extra

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	query	string	true	id parameter to match with a building ‘technical_id’ in ElasticSearch
territory_owner	query	string	true	territory_owner parameter to match with a building ‘territory_owner’

Request example

1
2
3
4
5
6
7



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

Responses

Code	Meaning	Description	Schema
200	OK	Success	_building_extra_data
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	not_found_response
default	Default	Error	error_response

getUnitById

Returns a single building object

GET /orgs/{orgId}/coverage/units/{id}

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	path	string	true	Unit identifier (Gescal 37)
parent_coverage	query	boolean	false	Boolean to chose if return the parent coverage

Request example

1
2
3
4
5
6
7



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/coverage/units/{id}?parent_coverage='true' \
  -H "Accept: application/json" \
  -H "sf-channel: string" \
  -H "sf-segment: string" \
  -H "sf-check-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Code	Meaning	Description	Schema
200	OK	Success	_unit
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	not_found_response
default	Default	Error	error_response

getUnitExtraData

Returns an extraData object for a unit 'id' and 'territory_owner'.

GET /orgs/{orgId}/coverage/units/extra

Parameters

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	query	string	true	id parameter to match with a unit ‘id’ in ElasticSearch
territory_owner	query	string	true	territory_owner parameter to match with a unit ‘territory_owner’

Request example

1
2
3
4
5
6
7



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

Responses

Code	Meaning	Description	Schema
200	OK	Success	_unit_extra_data
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	not_found_response
default	Default	Error	error_response

get__orgs_{orgId}_coverage_address-codes_vendor

Returns an addressCode object for a building 'id' and 'vendor'.

GET /orgs/{orgId}/coverage/address-codes/vendor

Parameters {id=“get__orgs_{orgid}_coverage_address-codes_vendor-parameter”}

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
id	query	string	true	id parameter to match with a street ‘id’ in ElasticSearch (gescal12 o gescal17)
vendor	query	string	true	vendor parameter to match with a ‘vendor’

Request example

1
2
3
4
5
6
7



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/coverage/address-codes/vendor?id='string'&vendor='experian'?id=string&vendor=experian \
  -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}_coverage_address-codes_vendor-response”}

Code	Meaning	Description	Schema
200	OK	Success	_address_code_data
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	not_found_response
default	Default	Error	error_response

get__orgs_{orgId}_coverage_streets_clarifiers_{gescal12}

Provides information to identify a building from a street.

GET /orgs/{orgId}/coverage/streets/clarifiers/{gescal12}

Parameters {id=“get__orgs_{orgid}_coverage_streets_clarifiers_{gescal12}-parameter”}

Name	In	Type	Required	Description
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
orgId	path	string	true	Organization name as it is registered in Mas-Stack
gescal12	path	string	true	g12

Request example

1
2
3
4
5
6
7



curl -X GET https://feasibility.sta.masstack.com/v1/orgs/masmovil/coverage/streets/clarifiers/123123123123 \
  -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}_coverage_streets_clarifiers_{gescal12}-response”}

Code	Meaning	Description	Schema
200	OK	Success	[_clarifier]
400	Bad Request	Bad request	bad_request_response
404	Not Found	Not found	not_found_response
default	Default	Error	error_response