Download Service WSDL Contract Download Service OSD Contract

Service	Operation	Description
Cinema	GetContributorRoles	List contribution roles. Parameters: PageNumber (optional, defaults to 1); RecordsPerPage (optional, defaults to 0);
	GetCountryAuthority	Get the given country's rating authority details, including the possible movie ratings. Parameters: CountryId (Sapo GIS CountryId);
	GetGenres	Get movie genres list. Parameters: PageNumber (optional, defaults to 1), RecordsPerPage (optional, defaults to 10);
	GetMoviePremieres	List movies with premiere data associated. Parameters: ReleaseCountryId (optional, default = PT); StartDate (ex. 2009-07-01, optional, default = start of current week, Sunday 00:00); EndDate (2009-07-01, optional, default = end of current week, Saturday 23:59); ProductionCountryIds (optional, ex. PT,ES); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04,M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)
	GetMoviesWithShowTimes	List movies with show-times within the given locations and time period. Parameters: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-07-10, optional, default = last Thursday); EndDate (2009-07-01, optional, default = next Thursday); ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10);
	GetPersons	List persons according to filters (paginated). IncludeReleaseWithCountryId default = PT; PageNumber default = 1; RecordsPerPage default = 10, Max itens = 20;
	GetTheaters	List theaters within the the given locations, with amount movies.
	GetTheatersWithShowTimes	List theaters within the given locations with show-times within the time period. Parametres: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009-09-01, optional, default = next Thursday), ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)
GIS	GetCategories	Returns a list of categories.
	GetCategoriesByTag	Returns a list of categories given a tag.
	GetCountries	Returns a list with all the countries in the system.
	GetDistrictById	Returns the data of a district given an id
	GetDistrictsSortedById	Returns a list of districts ordered by id
	GetDistrictsSortedByName	Returns a list of districts ordered by name
	GetLanguages	Returns the languages present on the system, in the IETF language tag schema.
	GetLastPOIs	Returns the last registered POIs.
	GetLastPOIsByCategoryId	Returns the last registered POIs, given a category id
	GetMatchLevels	Returns a list of available match levels (i.e. precision of the georeferentiation)
	GetMunicipalitiesByDistrictIdSortedById	Returns a list of municipalities given a district, ordered by id
	GetMunicipalitiesByDistrictIdSortedByName	Returns a list of municipalities given a district, ordered by name
	GetMunicipalitiesSortedById	Returns a list of municipalities ordered by id
	GetMunicipalitiesSortedByName	Returns a list of municipalities ordered by name
	GetMunicipalityById	Returns the data of a municipality given an id
	GetNeighborDistricts	Returns a list of neighboring districts
	GetNeighborMunicipalities	Returns a list of neighboring municipalities
	GetNeighborParishes	Returns a list of neighboring parishes
	GetParishById	Returns the data of a parish given an id
	GetParishesByMunicipalityIdSortedById	Returns a list of parishes given a municipality, ordered by id
	GetParishesByMunicipalityIdSortedByName	Returns a list of parishes given a municipality, ordered by name
	GetParishesSortedById	Returns a list of parishes ordered by id
	GetParishesSortedByName	Returns a list of parishes ordered by name
	GetPOIByBoundingBox	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the BoundingBox and an optional category
	GetPOIByBoundingBoxAndCategoryIdAndText	Returns a list of POIs given a bounding box, a category id and a textual description. Optionally the result could be filtered by macth level and/or thrust level if the values are specified.
	GetPOIByCategoryIdAndSourceId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a district and a category
	GetPOIByCategoryIdAndText	Returns a list of POIs given a category id and a textual description. Optionally the result could be filtered by district and/or municipality if the ids are specified.
	GetPOIByCoordinates	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the coordinates
	GetPOIByCoordinatesAndCategories	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the coordinates and a set of categories
	GetPOIByCoordinatesAndCategoryId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the coordinates and a category
	GetPOIByCoordinatesAndText	Gets a list of POIs given a pair of coordinates and a text description
	GetPOIByDistrictId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a district
	GetPOIByDistrictIdAndCategoryId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a district and a category
	GetPOIByDistrictIdAndText	Returns a list of POIs from a given district and filtered by the specified text
	GetPOIById	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given an id
	GetPOIByMunicipalityId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a municipality
	GetPOIByMunicipalityIdAndCategoryId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a municipality and a category
	GetPOIByMunicipalityIdAndText	Returns a list of POIs from a given municipality and filtered by the specified text
	GetPOIByParishId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a parish
	GetPOIByParishIdAndCategoryId	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a parish and a category
	GetPOIByParishIdAndText	Returns a list of POIs from a given parish and filtered by the specified text
	GetPOIByPOISourceId	Returns a POI, given its categoryId, sourceId and poiSourceId.
	GetPOIByTags	Returns a list of POIs given a tag list.
	GetPOIByText	Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given an expression
	GetTrustLevels	Returns a list of the available trust levels. These levels indicate the quality level of the georeferentiation.

Cinema Service

GetContributorRoles

List contribution roles. Parameters: PageNumber (optional, defaults to 1); RecordsPerPage (optional, defaults to 0);

Request Parameters

PageNumber : int (optional)
RecordsPerPage : int (optional)

Response Parameters

GetContributorRolesResult : ListOfContributorRoles (required)

List contribution roles. Parameters: PageNumber (optional, defaults to 1); RecordsPerPage (optional, defaults to 0);

Go to top

GetCountryAuthority

Get the given country's rating authority details, including the possible movie ratings. Parameters: CountryId (Sapo GIS CountryId);

Request Parameters

CountryId : string (required)

Response Parameters

GetCountryAuthorityResult : Authority (required)

Get the given country's rating authority details, including the possible movie ratings. Parameters: CountryId (Sapo GIS CountryId);

Go to top

GetGenres

Get movie genres list. Parameters: PageNumber (optional, defaults to 1), RecordsPerPage (optional, defaults to 10);

Request Parameters

PageNumber : int (optional)
RecordsPerPage : int (optional)

Response Parameters

GetGenresResult : ListOfGenres (required)

Get movie genres list. Parameters: PageNumber (optional, defaults to 1), RecordsPerPage (optional, defaults to 10);

Go to top

GetMoviePremieres

List movies with premiere data associated. Parameters: ReleaseCountryId (optional, default = PT); StartDate (ex. 2009-07-01, optional, default = start of current week, Sunday 00:00); EndDate (2009-07-01, optional, default = end of current week, Saturday 23:59); ProductionCountryIds (optional, ex. PT,ES); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04,M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)

Request Parameters

ReleaseCountryId : string (optional)
StartDate : date (optional)
EndDate : date (optional)
ProductionCountryIds : ArrayOfProductionCountryId (optional)
GenreIds : ArrayOfGenreId (optional)
ReleaseRatingIds : ArrayOfRatingId (optional)
IncludeContributors : boolean (optional)
IncludeSynopsis : boolean (optional)
PageNumber : int (optional)
RecordsPerPage : int (optional)
Version : int (optional)

Response Parameters

GetMoviePremieresResult : ListOfMovies (required)

Go to top

GetMoviesWithShowTimes

List movies with show-times within the given locations and time period. Parameters: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-07-10, optional, default = last Thursday); EndDate (2009-07-01, optional, default = next Thursday); ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10);

Request Parameters

ReleaseCountryId : string (optional)
LocationIds : ArrayOfLocationId (optional)
StartDate : date (optional)
EndDate : date (optional)
ProductionCountryIds : ArrayOfProductionCountryId (optional)
GenreIds : ArrayOfGenreId (optional)
ReleaseRatingIds : ArrayOfRatingId (optional)
IncludeShowTimesDetails : boolean (optional)
IncludeContributors : boolean (optional)
IncludeSynopsis : boolean (optional)
IncludeGenres : boolean (optional): Disables show details of the genre in the film
IncludeReferences : boolean (optional)
IncludeRelease : boolean (optional)
IncludeMedia : boolean (optional)
Version : int (optional)
PageNumber : int (optional)
RecordsPerPage : int (optional)

Response Parameters

GetMoviesWithShowTimesResult : ListOfMovies (required)

Go to top

GetPersons

List persons according to filters (paginated). IncludeReleaseWithCountryId default = PT; PageNumber default = 1; RecordsPerPage default = 10, Max itens = 20;

Request Parameters

BirthCountryId : string (optional)
IncludeReleaseWithCountryId : string (optional)
SearchTerms : string (optional)
PageNumber : int (optional)
RecordsPerPage : int (optional)

Response Parameters

GetPersonsResult : ListOfPerson (required)

Go to top

GetTheaters

List theaters within the the given locations, with amount movies.

Request Parameters

ReleaseCountryId : string (required)
LocationIds : ArrayOfLocationId (optional)
PageNumber : int (optional)
RecordsPerPage : int (required)

Response Parameters

GetTheatersResult : ListOfTheaters (required)

Go to top

GetTheatersWithShowTimes

List theaters within the given locations with show-times within the time period. Parametres: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009-09-01, optional, default = next Thursday), ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)

Request Parameters

ReleaseCountryId : string (optional)
LocationIds : ArrayOfLocationId (optional)
StartDate : date (optional)
EndDate : date (optional)
ProductionCountryIds : ArrayOfProductionCountryId (optional)
GenreIds : ArrayOfGenreId (optional)
ReleaseRatingIds : ArrayOfRatingId (optional)
IncludeShowTimeDetails : boolean (optional)
IncludeLocation : boolean (optional)
PageNumber : int (optional)
RecordsPerPage : int (optional)
Version : int (optional)

Response Parameters

GetTheatersWithShowTimesResult : ListOfTheaters (required)

List theaters within the given locations with show-times within the time period. Parameters: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009, optional, default = next Thursday); ProductionCountryIds (optional, ex. Es,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, PT,ES); PageNumber (optional, default = 1), RecordsPerPage (optional, default = 10);

Go to top

GIS Service

GetCategories

Returns a list of categories.

Request Parameters

includeDetails : boolean (optional)

Response Parameters

GetCategoriesResult : ArrayOfCategory (optional)

Go to top

GetCategoriesByTag

Returns a list of categories given a tag.

Request Parameters

tag : string (optional)

Response Parameters

GetCategoriesByTagResult : ArrayOfCategory (optional)

Go to top

GetCountries

Returns a list with all the countries in the system.

Response Parameters

GetCountriesResult : ArrayOfCountry (optional)

Go to top

GetDistrictById

Returns the data of a district given an id

Request Parameters

districtId : string (optional)

Response Parameters

GetDistrictByIdResult : District (optional)

Go to top

GetDistrictsSortedById

Returns a list of districts ordered by id

Request Parameters

includeMunicipalities : boolean (optional)

Response Parameters

GetDistrictsSortedByIdResult : ArrayOfDistrict (optional)

Go to top

GetDistrictsSortedByName

Returns a list of districts ordered by name

Request Parameters

includeMunicipalities : boolean (optional)

Response Parameters

GetDistrictsSortedByNameResult : ArrayOfDistrict (optional)

Go to top

GetLanguages

Returns the languages present on the system, in the IETF language tag schema.

Response Parameters

GetLanguagesResult : ArrayOfLanguage (required)

Go to top

GetLastPOIs

Returns the last registered POIs.

Request Parameters

pageNumber : int (required)
recordsPerPage : int (required)

Response Parameters

GetLastPOIsResult : ArrayOfPOI (optional)

Go to top

GetLastPOIsByCategoryId

Returns the last registered POIs, given a category id

Request Parameters

categoryId : int (required)
pageNumber : int (required)
recordsPerPage : int (required)

Response Parameters

GetLastPOIsByCategoryIdResult : ArrayOfPOI (optional)

Go to top

GetMatchLevels

Returns a list of available match levels (i.e. precision of the georeferentiation)

Response Parameters

GetMatchLevelsResult : ArrayOfMatchLevel (optional)

Go to top

GetMunicipalitiesByDistrictIdSortedById

Returns a list of municipalities given a district, ordered by id

Request Parameters

districtId : string (required)

Response Parameters

GetMunicipalitiesByDistrictIdSortedByIdResult : ArrayOfMunicipality (optional)

Go to top

GetMunicipalitiesByDistrictIdSortedByName

Returns a list of municipalities given a district, ordered by name

Request Parameters

districtId : string (required)

Response Parameters

GetMunicipalitiesByDistrictIdSortedByNameResult : ArrayOfMunicipality (optional)

Go to top

GetMunicipalitiesSortedById

Returns a list of municipalities ordered by id

Request Parameters

includeParishes : boolean (required)

Response Parameters

GetMunicipalitiesSortedByIdResult : ArrayOfMunicipality (optional)

Go to top

GetMunicipalitiesSortedByName

Returns a list of municipalities ordered by name

Request Parameters

includeParishes : boolean (required)

Response Parameters

GetMunicipalitiesSortedByNameResult : ArrayOfMunicipality (optional)

Go to top

GetMunicipalityById

Returns the data of a municipality given an id

Request Parameters

municipalityId : string (optional)

Response Parameters

GetMunicipalityByIdResult : Municipality (optional)

Go to top

GetNeighborDistricts

Returns a list of neighboring districts

Request Parameters

districtId : string (required)

Response Parameters

GetNeighborDistrictsResult : ArrayOfParish (optional)

Go to top

GetNeighborMunicipalities

Returns a list of neighboring municipalities

Request Parameters

municipalityId : string (required)

Response Parameters

GetNeighborMunicipalitiesResult : ArrayOfParish (optional)

Go to top

GetNeighborParishes

Returns a list of neighboring parishes

Request Parameters

parishId : string (required)

Response Parameters

GetNeighborParishesResult : ArrayOfParish (optional)

Go to top

GetParishById

Returns the data of a parish given an id

Request Parameters

parishId : string (optional)

Response Parameters

GetParishByIdResult : Parish (optional)

Go to top

GetParishesByMunicipalityIdSortedById

Returns a list of parishes given a municipality, ordered by id

Request Parameters

municipalityId : string (required)

Response Parameters

GetParishesByMunicipalityIdSortedByIdResult : ArrayOfParish (optional)

Go to top

GetParishesByMunicipalityIdSortedByName

Returns a list of parishes given a municipality, ordered by name

Request Parameters

municipalityId : string (required)

Response Parameters

GetParishesByMunicipalityIdSortedByNameResult : ArrayOfParish (optional)

Go to top

GetParishesSortedById

Returns a list of parishes ordered by id

Response Parameters

GetParishesSortedByIdResult : ArrayOfParish (optional)

Go to top

GetParishesSortedByName

Returns a list of parishes ordered by name

Response Parameters

GetParishesSortedByNameResult : ArrayOfParish (optional)

Go to top

GetPOIByBoundingBox

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the BoundingBox and an optional category

Request Parameters

latitude1 : double (required)
longitude1 : double (required)
latitude2 : double (required)
longitude2 : double (required)
categoryId : string (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByBoundingBoxResult : ArrayOfPOI (optional)

Go to top

GetPOIByBoundingBoxAndCategoryIdAndText

Returns a list of POIs given a bounding box, a category id and a textual description. Optionally the result could be filtered by macth level and/or thrust level if the values are specified.

Request Parameters

latitude1 : float (required)
latitude2 : float (required)
longitude1 : float (required)
longitude2 : float (required)
categoryId : string (required)
text : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)

Response Parameters

GetPOIByBoundingBoxAndCategoryIdAndTextResult : ArrayOfPOI (optional)

Go to top

GetPOIByCategoryIdAndSourceId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a district and a category

Request Parameters

categoryId : string (required)
sourceId : string (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)
districtId : string (optional)

Response Parameters

GetPOIByCategoryIdAndSourceIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByCategoryIdAndText

Returns a list of POIs given a category id and a textual description. Optionally the result could be filtered by district and/or municipality if the ids are specified.

Request Parameters

categoryId : string (required)
districtId : string (optional)
municipalityId : string (optional)
parisId : string (optional)
text : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)
tags : string (optional): Field for passing tags, comma separated.

Response Parameters

GetPOIByCategoryIdAndTextResult : ArrayOfPOI (optional)

Go to top

GetPOIByCoordinates

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the coordinates

Request Parameters

latitude : float (optional)
longitude : float (optional)
radius : float (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)

Response Parameters

GetPOIByCoordinatesResult : ArrayOfPOI (optional)

Go to top

GetPOIByCoordinatesAndCategories

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the coordinates and a set of categories

Request Parameters

latitude : float (required)
longitude : float (required)
radius : float (required)
categories : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)

Response Parameters

GetPOIByCoordinatesAndCategoriesResult : ArrayOfPOI (optional)

Go to top

GetPOIByCoordinatesAndCategoryId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given the coordinates and a category

Request Parameters

latitude : float (optional)
longitude : float (optional)
radius : float (optional)
categoryId : int (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
sourceId : string (optional)

Response Parameters

GetPOIByCoordinatesAndCategoryIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByCoordinatesAndText

Gets a list of POIs given a pair of coordinates and a text description

Request Parameters

latitude : float (required)
longitude : float (required)
radius : float (required)
text : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)

Response Parameters

GetPOIByCoordinatesAndTextResult : ArrayOfPOI (optional)

Go to top

GetPOIByDistrictId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a district

Request Parameters

districtId : string (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByDistrictIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByDistrictIdAndCategoryId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a district and a category

Request Parameters

districtId : string (required)
categoryId : string (required)
text : string (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)
sourceId : string (optional)

Response Parameters

GetPOIByDistrictIdAndCategoryIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByDistrictIdAndText

Returns a list of POIs from a given district and filtered by the specified text

Request Parameters

districtId : string (required)
text : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByDistrictIdAndTextResult : ArrayOfPOI (optional)

Go to top

GetPOIById

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given an id

Request Parameters

poiId : string (optional)

Response Parameters

GetPOIByIdResult : POI (optional)

Go to top

GetPOIByMunicipalityId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a municipality

Request Parameters

municipalityId : string (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByMunicipalityIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByMunicipalityIdAndCategoryId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a municipality and a category

Request Parameters

municipalityId : string (optional)
categoryId : int (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)
sourceId : string (optional)

Response Parameters

GetPOIByMunicipalityIdAndCategoryIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByMunicipalityIdAndText

Returns a list of POIs from a given municipality and filtered by the specified text

Request Parameters

municipalityId : string (required)
text : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByMunicipalityIdAndTextResult : ArrayOfPOI (optional)

Go to top

GetPOIByParishId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a parish

Request Parameters

parishId : string (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByParishIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByParishIdAndCategoryId

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given a parish and a category

Request Parameters

parishId : string (optional)
categoryId : int (optional)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByParishIdAndCategoryIdResult : ArrayOfPOI (optional)

Go to top

GetPOIByParishIdAndText

Returns a list of POIs from a given parish and filtered by the specified text

Request Parameters

parishId : string (required)
text : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByParishIdAndTextResult : ArrayOfPOI (optional)

Go to top

GetPOIByPOISourceId

Returns a POI, given its categoryId, sourceId and poiSourceId.

Request Parameters

categoryId : int (required)
sourceId : int (required)
poiSourceId : string (required)

Response Parameters

GetPOIByPOISourceIdResult : POI (required)

Go to top

GetPOIByTags

Returns a list of POIs given a tag list.

Request Parameters

tags : string (required)
matchlevelId : int (optional)
trustlevelId : int (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByTagsResult : ArrayOfPOI (optional)

Go to top

GetPOIByText

Returns points of interest (locations, monuments, banks, hospitals, post offices, etc) given an expression

Request Parameters

text : string (optional)
pageNumber : int (optional)
recordsPerPage : int (optional)
startPublicationDate : dateTime (optional)
endPublicationDate : dateTime (optional)

Response Parameters

GetPOIByTextResult : ArrayOfPOI (optional)

Go to top

GetTrustLevels

Returns a list of the available trust levels. These levels indicate the quality level of the georeferentiation.

Response Parameters

GetTrustLevelsResult : ArrayOfTrustLevel (optional)

Go to top

Cinema Entities

ArrayOfContribution

Attribute Name	Description
List of Contribution : Contribution (optional)

Go to top

ArrayOfContributor

Attribute Name	Description
List of Contributor : Contributor (optional)

Go to top

ArrayOfContributorRole

Attribute Name	Description
List of ContributorRole : ContributorRole (optional)

Go to top

ArrayOfCountry

Go to top

ArrayOfExternalId

Attribute Name	Description
List of ExternalId : ExternalId (optional)

Go to top

ArrayOfGenre

Attribute Name	Description
List of Genre : Genre (optional)

Go to top

ArrayOfGenreId

Attribute Name	Description
List of GenreId : string (optional)

Go to top

ArrayOfLink

Attribute Name	Description
List of Link : Link (optional)

Go to top

ArrayOfLocationId

Attribute Name	Description
List of LocationId : string (optional)

Go to top

ArrayOfMediaItem

Attribute Name	Description
List of MediaItem : MediaItem (optional)

Go to top

ArrayOfMovie

Attribute Name	Description
List of Movie : Movie (optional)

Go to top

ArrayOfMovieShowTimes

Attribute Name	Description
List of MovieShowTimes : MovieShowTimes (optional)

Go to top

ArrayOfPerson

Attribute Name	Description
List of Person : Person (optional)

Go to top

ArrayOfProductionCountryId

Attribute Name	Description
List of ProductionCountryId : string (optional)

Go to top

ArrayOfQuote

Attribute Name	Description
List of Quote : Quote (optional)

Go to top

ArrayOfRating

Attribute Name	Description
List of Rating : Rating (optional)

Go to top

ArrayOfRatingId

Attribute Name	Description
List of RatingId : string (optional)

Go to top

ArrayOfShowTime

Attribute Name	Description
List of ShowTime : ShowTime (optional)

Go to top

ArrayOfTheater

Attribute Name	Description
List of Theater : Theater (optional)

Go to top

ArrayOfTheaterShowTimes

Attribute Name	Description
List of TheaterShowTimes : TheaterShowTimes (optional)

Go to top

ArrayOfThumbnail

Attribute Name	Description
List of Thumbnail : Thumbnail (optional)

Go to top

ArrayOfVersions

Attribute Name	Description
List of Version : Version (optional)

Go to top

Authority

Attribute Name	Description
Id : string
Name : string
Country : Country (optional)
Ratings : ArrayOfRating (optional)

Go to top

Contact

Attribute Name	Description
URL : string (optional)
Email : string (optional)
Phone : string (optional)
CellPhone : string (optional)

Go to top

Contribution

Attribute Name	Description
Movie : Movie
Role : ContributorRole

Go to top

Contributor

Attribute Name	Description
SourceId : string
Source : string

Go to top

ContributorRole

Attribute Name	Description
Id : string
Name : string

Go to top

Country

Go to top

ExternalId

Attribute Name	Description
Source : ExternalIdSource
Id : string

Go to top

ExternalIdSource

Value Name	Description
Meo
Sercultur
IMDB

Go to top

Genre

Attribute Name	Description
Id : string
Name : string
Slug : string (optional)
WorkCount : int (optional)

Go to top

Link

Go to top

ListOfContributorRoles

Attribute Name	Description
ContributorRoles : ArrayOfContributorRole
PaginationDetails : PaginationDetails

Go to top

ListOfGenres

Attribute Name	Description
Genres : ArrayOfGenre
PaginationDetails : PaginationDetails

Go to top

ListOfMovies

Attribute Name	Description
Movies : ArrayOfMovie
PaginationDetails : PaginationDetails

Go to top

ListOfPerson

Attribute Name	Description
Persons : ArrayOfPerson
PaginationDetails : PaginationDetails

Go to top

ListOfTheaters

Attribute Name	Description
Theaters : ArrayOfTheater
PaginationDetails : PaginationDetails

Go to top

Location

Attribute Name	Description
CountryId : string (optional)
CountryName : string (optional)
DistrictId : string (optional)
DistrictName : string (optional)
MunicipalityId : string (optional)
MunicipalityName : string (optional)
ParishId : string (optional)
ParishName : string (optional)
Latitude : float (optional)
Longitude : float (optional)
Metadata : LocationMetadata (optional)
ZipCode : string (optional)
Locality : string (optional)
Street : string (optional)
HouseNumber : string (optional)
MatchLevel : string (optional)

Go to top

LocationMetadata

Attribute Name	Description
Provider : string
TrustLevel : string (optional)
ISP : string (optional)

Go to top

MediaCategory

Value Name	Description
Poster
Trailer
Image
Video

Go to top

MediaItem

RandName é o identificador único de um vídeo na plataforma SAPO Videos. Para mais informação, consultar: http://services.sapo.pt/Metadata/Service/Videos

Attribute Name	Description
Type : MediaType
Category : MediaCategory
Name : string (optional)
URL : string (optional)
RandName : string (optional)
Extension : string (optional)
Width : float (optional)
Height : float (optional)
Thumbnails : ArrayOfThumbnail (optional)

Go to top

MediaType

Value Name	Description
Image
Video

Go to top

Movie

Attribute Name	Description
Id : string
Url : string (optional)
Title : string (optional)
Release : Release (optional)
Year : int (optional)
ProductionCountries : ArrayOfCountry (optional)
Runtime : int (optional)
Synopsis : string (optional)
Contributors : ArrayOfContributor (optional)
Genres : ArrayOfGenre (optional)
Media : ArrayOfMediaItem (optional)
References : References (optional)
TheaterShowTimesList : ArrayOfTheaterShowTimes (optional)
CreateDate : dateTime
UpdateDate : dateTime (optional)
Quotes : ArrayOfQuote (optional)
Version : int (optional)
VersionAbbr : string (optional)
Versions : ArrayOfVersions (optional)
Rating : int (optional)

Go to top

MovieShowTimes

Attribute Name	Description
Movie : Movie
ShowTimes : ArrayOfShowTime
TheaterTicketOfficeURL : string (optional)

Go to top

PaginationDetails

Attribute Name	Description
CurrentPage : integer
RecordsPerPage : integer
RecordsTotal : integer

Go to top

Person

Attribute Name	Description
Id : string
Url : string (optional)
Name : string
BornDate : date (optional)
DiedDate : date (optional)
Country : Country (optional)
Biography : string (optional)
Media : ArrayOfMediaItem (optional)
Contributions : ArrayOfContribution (optional)
CreateDate : dateTime (optional)
UpdateDate : dateTime (optional)

Go to top

Quote

Attribute Name	Description
Title : string
CharacterName : string
Movie : Movie (optional)

Go to top

Rating

Attribute Name	Description
Id : string
Name : string

Go to top

References

Attribute Name	Description
ExternalIds : ArrayOfExternalId (optional)
Links : ArrayOfLink (optional)

Go to top

Release

Attribute Name	Description
Country : Country
Title : string (optional)
Distributor : string (optional)
ReleaseDate : dateTime (optional)
Rating : Rating (optional)
Authority : Authority (optional)

Go to top

ShowTime

Attribute Name	Description
TimeStart : dateTime
ShowTimeTicketOfficeURL : string (optional)

Go to top

Theater

Attribute Name	Description
Id : string
Name : string
Contact : Contact (optional)
TicketOfficeURL : string (optional)
Location : Location (optional)
Description : string (optional)
MovieShowTimesList : ArrayOfMovieShowTimes (optional)
CreateDate : dateTime
UpdateDate : dateTime (optional)
MoviesTotal : int (optional)

Go to top

TheaterShowTimes

Attribute Name	Description
Theater : Theater
ShowTimes : ArrayOfShowTime
TheaterTicketOfficeURL : string (optional)

Go to top

Thumbnail

Attribute Name	Description
Name : string (optional)
URL : string
Width : float
Height : float

Go to top

Version

Attribute Name	Description
Id : int
Abbr : string
IsMain : boolean

Go to top

GIS Entities

ArrayOfCategory

Attribute Name	Description
List of Category : Category (optional)

Go to top

ArrayOfCountry

Go to top

ArrayOfDistrict

Attribute Name	Description
List of District : District (optional)

Go to top

ArrayOfLanguage

Go to top

ArrayOfMatchLevel

Go to top

ArrayOfMunicipality

Attribute Name	Description
List of Municipality : Municipality (optional)

Go to top

ArrayOfParish

Attribute Name	Description
List of Parish : Parish (optional)

Go to top

ArrayOfPOI

Attribute Name	Description
List of POI : POI (optional)

Go to top

ArrayOfTrustLevel

Go to top

Contributor

Attribute Name	Description
SourceId : string
Source : string

Go to top

Contributors

Attribute Name	Description
List of Contributor : Contributor (optional)

Go to top

Details

Attribute Name	Description
User : User (optional)
Icon : string (optional)
Pictures : Pictures (optional)
Movies : Movies (optional)
Contributors : Contributors (optional)

Go to top

DetailXml

Attribute Name	Description
Details : Details

Go to top

District

Attribute Name	Description
DistrictId : string (optional)
DistrictName : string (optional)
Latitude : float (optional)
Longitude : float (optional)
Municipalities : ArrayOfMunicipality (optional)

Go to top

Media

Go to top

Movies

Attribute Name	Description
List of Movie : Media (optional)

Go to top

Municipality

Attribute Name	Description
MunicipalityId : string (optional)
MunicipalityName : string (optional)
Latitude : float (optional)
Longitude : float (optional)
UrlForm : string (optional)
Parishes : ArrayOfParish (optional)

Go to top

Parish

Attribute Name	Description
ParishId : string (optional)
ParishName : string (optional)
Latitude : float (optional)
Longitude : float (optional)

Go to top

Pictures

Attribute Name	Description
List of Picture : Media (optional)

Go to top

POI

Attribute Name	Description
POIId : string (optional)
Name : string (optional)
CountryId : string (optional)
Country : string (optional)
DistrictId : string (optional)
District : string (optional)
MunicipalityId : string (optional)
Municipality : string (optional)
ParishId : string (optional)
Parish : string (optional)
Address : string (optional)
ZipCode : string (optional)
Phone : string (optional)
Fax : string (optional)
LocalityId : int (optional)
Locality : string (optional)
StreetId : int (optional)
Street : string (optional)
HouseNumber : string (optional)
Latitude : float (optional)
Longitude : float (optional)
Distance : float (optional)
CategoryId : string (optional)
Category : string (optional)
MimeType : string (optional)
SourceId : int (optional)
Source : string (optional)
POISourceId : string (optional)
URL : string (optional)
EMail : string (optional)
PublicationDate : string (optional)
RegistrationDate : string (optional)
ExpirationDate : string (optional)
Description : string (optional)
Detail : string (optional)
Tags : string (optional)
MatchLevelId : int (optional)
MatchLevel : string (optional)
TrustLevelId : int (optional)
TrustLevel : string (optional)
LastModified : string (optional)
Revision : string (optional)
DetailXml : DetailXml (optional)
UserToken : string (optional)

Go to top

User

Go to top

Elements	Description
ESBUsername	The e-mail of the account that is used to access the API.
ESBPassword	The password that in combination with the ESBUsername is used to access the corresponding account.
ESBToken	An authentication token generated by using an user name (ESBUsername) and password (ESBPassword). It should be used a ESBToken or the combination of ESBUsername and ESBPassword.
ESBAccessKey	The authorization key used to authorize the request against your purchase. The account being used to access the service must be associated to this key.

Elements	Description
ESBUsername	The e-mail of the account that is used to access the API
ESBPassword	The password that in combination with the ESBUsername is used to access the corresponding account

Attribute Name	Description
CategoryId : int (optional)
CategoryName : string (optional)
Description : string (optional)
Tags : string (optional)

Name	Value
Abrantes	1401
Águeda	0101
Aguiar da Beira	0901
Alandroal	0701
Albergaria-a-Velha	0102
Albufeira	0801
Alcácer do Sal	1501
Alcanena	1402
Alcobaça	1001
Alcochete	1502
Alcoutim	0802
Alenquer	1101
Alfândega da Fé	0401
Alijó	1701
Aljezur	0803
Aljustrel	0201
Almada	1503
Almeida	0902
Almeirim	1403
Almodôvar	0202
Alpiarça	1404
Alter do Chão	1201
Alvaiázere	1002
Alvito	0203
Amadora	1115
Amarante	1301
Amares	0301
Anadia	0103
Angra do Heroísmo	4301
Ansião	1003
Arcos de Valdevez	1601
Arganil	0601
Armamar	1801
Arouca	0104
Arraiolos	0702
Arronches	1202
Arruda dos Vinhos	1102
Aveiro	0105
Avis	1203
Azambuja	1103
Baião	1302
Barcelos	0302
Barrancos	0204
Barreiro	1504
Batalha	1004
Beja	0205
Belmonte	0501
Benavente	1405
Bombarral	1005
Borba	0703
Boticas	1702
Braga	0303
Bragança	0402
Cabeceiras de Basto	0304
Cadaval	1104
Caldas da Rainha	1006
Calheta	3101
Calheta de São Jorge	4501
Câmara de Lobos	3102
Caminha	1602
Campo Maior	1204
Cantanhede	0602
Carrazeda de Ansiães	0403
Carregal do Sal	1802
Cartaxo	1406
Cascais	1105
Castanheira de Pêra	1007
Castelo Branco	0502
Castelo de Paiva	0106
Castelo de Vide	1205
Castro Daire	1803
Castro Marim	0804
Castro Verde	0206
Celorico da Beira	0903
Celorico de Basto	0305
Chamusca	1407
Chaves	1703
Cinfães	1804
Coimbra	0603
Condeixa-a-Nova	0604
Constância	1408
Coruche	1409
Corvo	4901
Covilhã	0503
Crato	1206
Cuba	0207
Elvas	1207
Entroncamento	1410
Espinho	0107
Esposende	0306
Estarreja	0108
Estremoz	0704
Évora	0705
Fafe	0307
Faro	0805
Felgueiras	1303
Ferreira do Alentejo	0208
Ferreira do Zêzere	1411
Figueira da Foz	0605
Figueira de Castelo Rodrigo	0904
Figueiró dos Vinhos	1008
Fornos de Algodres	0905
Freixo de Espada à Cinta	0404
Fronteira	1208
Funchal	3103
Fundão	0504
Gavião	1209
Góis	0606
Golegã	1412
Gondomar	1304
Gouveia	0906
Grândola	1505
Guarda	0907
Guimarães	0308
Horta	4701
Idanha-a-Nova	0505
Ílhavo	0110
Lagoa	0806
Lagoa	4201
Lagos	0807
Lajes das Flores	4801
Lajes do Pico	4601
Lamego	1805
Leiria	1009
Lisboa	1106
Loulé	0808
Loures	1107
Lourinhã	1108
Lousã	0607
Lousada	1305
Mação	1413
Macedo de Cavaleiros	0405
Machico	3104
Madalena	4602
Mafra	1109
Maia	1306
Mangualde	1806
Manteigas	0908
Marco de Canaveses	1307
Marinha Grande	1010
Marvão	1210
Matosinhos	1308
Mealhada	0111
Mêda	0909
Melgaço	1603
Mértola	0209
Mesão Frio	1704
Mira	0608
Miranda do Corvo	0609
Miranda do Douro	0406
Mirandela	0407
Mogadouro	0408
Moimenta da Beira	1807
Moita	1506
Monção	1604
Monchique	0809
Mondim de Basto	1705
Monforte	1211
Montalegre	1706
Montemor-o-Novo	0706
Montemor-o-Velho	0610
Montijo	1507
Mora	0707
Mortágua	1808
Moura	0210
Mourão	0708
Murça	1707
Murtosa	0112
Nazaré	1011
Nelas	1809
Nisa	1212
Nordeste	4202
Óbidos	1012
Odemira	0211
Odivelas	1116
Oeiras	1110
Oleiros	0506
Olhão	0810
Oliveira de Azeméis	0113
Oliveira de Frades	1810
Oliveira do Bairro	0114
Oliveira do Hospital	0611
Ourém	1421
Ourique	0212
Ovar	0115
Paços de Ferreira	1309
Palmela	1508
Pampilhosa da Serra	0612
Paredes	1310
Paredes de Coura	1605
Pedrógão Grande	1013
Penacova	0613
Penafiel	1311
Penalva do Castelo	1811
Penamacor	0507
Penedono	1812
Penela	0614
Peniche	1014
Peso da Régua	1708
Pinhel	0910
Pombal	1015
Ponta Delgada	4203
Ponta do Sol	3105
Ponte da Barca	1606
Ponte de Lima	1607
Ponte de Sor	1213
Portalegre	1214
Portel	0709
Portimão	0811
Porto	1312
Porto de Mós	1016
Porto Moniz	3106
Porto Santo	3201
Póvoa de Lanhoso	0309
Póvoa de Varzim	1313
Povoação	4204
Praia da Vitória	4302
Proença-a-Nova	0508
Redondo	0710
Reguengos de Monsaraz	0711
Resende	1813
Ribeira Brava	3107
Ribeira de Pena	1709
Ribeira Grande	4205
Rio Maior	1414
Sabrosa	1710
Sabugal	0911
Salvaterra de Magos	1415
Santa Comba Dão	1814
Santa Cruz	3108
Santa Cruz da Graciosa	4401
Santa Cruz das Flores	4802
Santa Maria da Feira	0109
Santa Marta de Penaguião	1711
Santana	3109
Santarém	1416
Santiago do Cacém	1509
Santo Tirso	1314
São Brás de Alportel	0812
São João da Madeira	0116
São João da Pesqueira	1815
São Pedro do Sul	1816
São Roque do Pico	4603
São Vicente	3110
Sardoal	1417
Sátão	1817
Seia	0912
Seixal	1510
Sernancelhe	1818
Serpa	0213
Sertã	0509
Sesimbra	1511
Setúbal	1512
Sever do Vouga	0117
Silves	0813
Sines	1513
Sintra	1111
Sobral de Monte Agraço	1112
Soure	0615
Sousel	1215
Tábua	0616
Tabuaço	1819
Tarouca	1820
Tavira	0814
Terras de Bouro	0310
Tomar	1418
Tondela	1821
Torre de Moncorvo	0409
Torres Novas	1419
Torres Vedras	1113
Trancoso	0913
Trofa	1318
Vagos	0118
Vale de Cambra	0119
Valença	1608
Valongo	1315
Valpaços	1712
Velas	4502
Vendas Novas	0712
Viana do Alentejo	0713
Viana do Castelo	1609
Vidigueira	0214
Vieira do Minho	0311
Vila de Rei	0510
Vila do Bispo	0815
Vila do Conde	1316
Vila do Porto	4101
Vila Flor	0410
Vila Franca de Xira	1114
Vila Franca do Campo	4206
Vila Nova da Barquinha	1420
Vila Nova de Cerveira	1610
Vila Nova de Famalicão	0312
Vila Nova de Foz Côa	0914
Vila Nova de Gaia	1317
Vila Nova de Paiva	1822
Vila Nova de Poiares	0617
Vila Pouca de Aguiar	1713
Vila Real	1714
Vila Real de Santo António	0816
Vila Velha de Ródão	0511
Vila Verde	0313
Vila Viçosa	0714
Vimioso	0411
Vinhais	0412
Viseu	1823
Vizela	0314
Vouzela	1824

Services SDB

Cinema Agenda

Technical Overview

GIS Service

Cinema Service

API Reference

Cinema Service

GetContributorRoles

Request Parameters

Response Parameters

GetCountryAuthority

Request Parameters

Response Parameters

GetGenres

Request Parameters

Response Parameters

GetMoviePremieres

Request Parameters

Response Parameters

GetMoviesWithShowTimes

Request Parameters

Response Parameters

GetPersons

Request Parameters

Response Parameters

GetTheaters

Request Parameters

Response Parameters

GetTheatersWithShowTimes

Request Parameters

Response Parameters

GIS Service

GetCategories

Request Parameters

Response Parameters

GetCategoriesByTag

Request Parameters

Response Parameters

GetCountries

Response Parameters

GetDistrictById

Request Parameters

Response Parameters

GetDistrictsSortedById

Request Parameters

Response Parameters

GetDistrictsSortedByName

Request Parameters

Response Parameters

GetLanguages

Response Parameters

GetLastPOIs

Request Parameters

Response Parameters

GetLastPOIsByCategoryId

Request Parameters

Response Parameters

GetMatchLevels

Response Parameters

GetMunicipalitiesByDistrictIdSortedById

Request Parameters

Response Parameters

GetMunicipalitiesByDistrictIdSortedByName

Request Parameters

Response Parameters

GetMunicipalitiesSortedById

Request Parameters

Response Parameters

GetMunicipalitiesSortedByName

Request Parameters

Response Parameters

GetMunicipalityById

Request Parameters

Response Parameters

GetNeighborDistricts

Request Parameters

Response Parameters

GetNeighborMunicipalities

Request Parameters

Response Parameters