| Service | Operation | Description |
|---|---|---|
| Culture | GetAgendaV2 | The operation GetAgendaV2 is the main operation of the Culture service. It retrieves the cultural events base on the filtering set. |
| GetContributorRoles | Return the role list that a contributor can have. | |
| GetGenres | Returns a list of event genres. | |
| GetLanguages | Returns a list of languages witch the events are writen. | |
| GetPremieresV2 | The operation GetPremieresV2 returns the premieres from the current day and forward. | |
| GetTags | Returns a tag list which the events are described. | |
| GetTargets | Returns a list of event target. | |
| GetTypes | Returns a list of types of events. | |
| GetVenues | Returns a list of Venues where events are happening. | |
| GIS | GetCountries | Returns a list with all the countries in the system. |
| GetDistrictsSortedByName | Returns a list of districts ordered by name | |
| GetMunicipalitiesSortedByName | Returns a list of municipalities ordered by name | |
| GetParishesByMunicipalityIdSortedByName | Returns a list of parishes given a municipality, ordered by name | |
| GetParishesSortedByName | Returns a list of parishes ordered by name |
Culture Service
GetAgendaV2
The operation GetAgendaV2 is the main operation of the Culture service. It retrieves the cultural events base on the filtering set.Request Parameters
- AgendaRequest : AgendaRequestV2 (required)
- Each element directly descendent of the AgendaRequest filled is a logical "and" for the service.
Response Parameters
- GetAgendaV2Result : ListOfEvent (required)
- Is a list of events and its pagination details.
Usage example
Request ResponseGetContributorRoles
Return the role list that a contributor can have.Request Parameters
- PageNumber : int (required)
- PageNumber is the listing page that will be retrieved. Is related with the RecordsPerPage element.
- RecordsPerPage : int (required)
- RecordsPerPage is the maximum number of elements that will be retrieved on a page. Is related with the PageNumber element.
Response Parameters
- GetContributorRolesResult : ListOfContributorRole (required)
- Is a list of contributor role and its pagination details
Usage example
Request ResponseGetGenres
Returns a list of event genres.Request Parameters
- PageNumber : int (required)
- PageNumber is the listing page that will be retrieved. Is related with the RecordsPerPage element.
- RecordsPerPage : int (required)
- RecordsPerPage is the maximum number of elements that will be retrieved on a page. Is related with the PageNumber element.
Response Parameters
- GetGenresResult : ListOfGenre (required)
- List of genre and its pagination details.
Usage example
Request ResponseGetLanguages
Returns a list of languages witch the events are writen.Request Parameters
- PageNumber : int (required)
- PageNumber is the listing page that will be retrieved. Is related with the RecordsPerPage element.
- RecordsPerPage : int (required)
- RecordsPerPage is the maximum number of elements that will be retrieved on a page. Is related with the PageNumber element.
Response Parameters
- GetLanguagesResult : ListOfLanguage (required)
- List of languages and its pagination details
Usage example
Request ResponseGetPremieresV2
The operation GetPremieresV2 returns the premieres from the current day and forward.Request Parameters
- PremiereRequest : PremiereRequestV2 (required)
- Contains the necessary parameters for the operation
Response Parameters
- GetPremieresV2Result : ListOfEvent (required)
- Is a list of events and its pagination details.
Usage example
Request ResponseGetTags
Returns a tag list which the events are described.Request Parameters
- PageNumber : int (required)
- PageNumber is the listing page that will be retrieved. Is related with the RecordsPerPage element.
- RecordsPerPage : int (required)
- RecordsPerPage is the maximum number of elements that will be retrieved on a page. Is related with the PageNumber element.
Response Parameters
- GetTagsResult : ListOfTag (required)
- Is a list of tags and its pagination details
Usage example
Request ResponseGetTargets
Returns a list of event target.Request Parameters
- PageNumber : int (required)
- PageNumber is the listing page that will be retrieved. Is related with the RecordsPerPage element.
- RecordsPerPage : int (required)
- RecordsPerPage is the maximum number of elements that will be retrieved on a page. Is related with the PageNumber element.
Response Parameters
- GetTargetsResult : ListOfTarget (required)
- Is a list of targets and its pagination details
Usage example
Request ResponseGetTypes
Returns a list of types of events.Request Parameters
- GenreId : string (optional)
- It will filter the types by genre.
- PageNumber : int (required)
- PageNumber is the listing page that will be retrieved. Is related with the RecordsPerPage element.
- RecordsPerPage : int (required)
- RecordsPerPage is the maximum number of elements that will be retrieved on a page. Is related with the PageNumber element.
Response Parameters
- GetTypesResult : ListOfType (required)
- Is a list of types and its pagination details
Usage example
Request ResponseGetVenues
Returns a list of Venues where events are happening.Request Parameters
- VenueRequest : VenueRequest (required)
- It contains the necessary parameters for the requests. Please read the technical documentation of the type
Response Parameters
- GetVenuesResult : ListOfVenue (required)
- Is a list of venues and its pagination details
Usage example
Request ResponseGIS Service
GetCountries
Returns a list with all the countries in the system.Response Parameters
- GetCountriesResult : ArrayOfCountry (optional)
GetDistrictsSortedByName
Returns a list of districts ordered by nameRequest Parameters
- includeMunicipalities : boolean (optional)
Response Parameters
- GetDistrictsSortedByNameResult : ArrayOfDistrict (optional)
GetMunicipalitiesSortedByName
Returns a list of municipalities ordered by nameRequest Parameters
- includeParishes : boolean (required)
Response Parameters
- GetMunicipalitiesSortedByNameResult : ArrayOfMunicipality (optional)
GetParishesByMunicipalityIdSortedByName
Returns a list of parishes given a municipality, ordered by nameRequest Parameters
- municipalityId : string (required)
Response Parameters
- GetParishesByMunicipalityIdSortedByNameResult : ArrayOfParish (optional)
GetParishesSortedByName
Returns a list of parishes ordered by nameResponse Parameters
- GetParishesSortedByNameResult : ArrayOfParish (optional)
Culture Entities
AgendaFilter
| Attribute Name | Description |
|---|---|
| LocationIds : LocationIds (optional) | |
| VenueIds : VenueIds (optional) | |
| GenreIds : GenreIds (optional) | |
| TypeIds : TypeIds (optional) | |
| TargetIds : TargetIds (optional) | |
| IGACRatings : IGACRatings (optional) | |
| Tags : Tags (optional) | |
| Highlights : Highlights (optional) | |
| SearchText : string (optional) |
AgendaRequestV2
The Filters and highlights elements should not be use simultaneously.| Attribute Name | Description |
|---|---|
| StartDate : dateTime | |
| EndDate : dateTime | |
| LanguageId : string | |
| IncludeDetails : boolean | |
| EventCorrelationId : string (optional) | The EventCorrelationId allows correlating events. E.g. A festival has many events occurring. The festival name is the EventCorrelationId and the operation result will be all the events that occur in the festival. |
| Filters : ArrayOfAgendaFilter (optional) | |
| Order : Ordering | |
| PageNumber : int | |
| RecordsPerPage : int |
ArrayOfAgendaFilter
| Attribute Name | Description |
|---|---|
| List of Filter : AgendaFilter (optional) |
ArrayOfContact
| Attribute Name | Description |
|---|---|
| List of Contact : Contact (optional) |
ArrayOfContributor
| Attribute Name | Description |
|---|---|
| List of Contributor : Contributor (optional) |
ArrayOfContributorRole
| Attribute Name | Description |
|---|---|
| List of ContributorRole : ContributorRole (optional) |
ArrayOfEvent
| Attribute Name | Description |
|---|---|
| List of Event : Event (optional) |
ArrayOfGenre
| Attribute Name | Description |
|---|---|
| List of Genre : Genre (optional) |
ArrayOfLanguage
ArrayOfMedia
| Attribute Name | Description |
|---|---|
| List of Media : Media (optional) |
ArrayOfPremiereFilter
| Attribute Name | Description |
|---|---|
| List of Filter : PremiereFilter (optional) |
ArrayOfTag
| Attribute Name | Description |
|---|---|
| List of Tag : Tag (optional) |
ArrayOfTarget
| Attribute Name | Description |
|---|---|
| List of Target : Target (optional) |
ArrayOfType
| Attribute Name | Description |
|---|---|
| List of Type : Type (optional) |
ArrayOfVenue
| Attribute Name | Description |
|---|---|
| List of Venue : Venue (optional) |
Contact
A Contact are a party physical and electronic addresses Name, e-mail, URL, phone, etc.| Attribute Name | Description |
|---|---|
| Name : string (optional) | |
| Url : string (optional) | |
| TicketOnlineUrl : string (optional) | |
| Email : string (optional) | |
| Phone : string (optional) | |
| MobilePhone : string (optional) |
Contributor
| Attribute Name | Description |
|---|---|
| SourceId : string | |
| Source : string |
ContributorRole
| Attribute Name | Description |
|---|---|
| Id : string | |
| Name : string (optional) |
Day
This is a definition of a day in an event context. A day has 24 hours period and is defined with a week day, the week in the month, the day of the month, a calendar date time (31-01-2011 01:01:01) and in this context it might be defined some time frames in which the event will occur (in this day).| Attribute Name | Description |
|---|---|
| WeekDay : WeekDay (optional) | |
| WeekInMonth : WeekInMonth (optional) | |
| MonthDay : MonthDay (optional) | |
| Month : Month (optional) | |
| CalendarDay : dateTime (optional) | |
| Timeframes : Timeframes (optional) |
Days
| Attribute Name | Description |
|---|---|
| List of Day : Day (optional) |
Event
An event is something that occurs at a specific place within a time span. A music show is an event that occurs in a venue (place) and has a start and a end date time| Attribute Name | Description |
|---|---|
| Id : string | |
| Name : string | |
| Genre : Genre (optional) | |
| Type : Type (optional) | |
| IGACRating : IGACRating (optional) | |
| Target : Target (optional) | |
| Language : Language (optional) | |
| Venue : Venue (optional) | |
| Schedule : Schedule (optional) | |
| Duration : int (optional) | |
| Description : string (optional) | |
| Summary : string (optional) | |
| Images : ArrayOfMedia (optional) | |
| Contact : Contact (optional) | |
| Price : string (optional) | |
| OnlinePointsOfSale : ArrayOfContact (optional) | |
| TrailerUrl : string (optional) | |
| SapoVideoTrailerURL : string (optional) | |
| EventCorrelationId : int (optional) | |
| EventCorrelationName : string (optional) | |
| TechnicalFile : ArrayOfContributor (optional) | |
| Tags : ArrayOfTag (optional) | |
| ScheduleSummary : string (optional) |
ExceptionalDay
When a recorrency is defined, it may occur some exceptions to that particular recorrency. The ExceptionalDay is as exception to that recurrency. It's defined a day and what acction that day will make to the recorrency with the type of the ExceptionalDay.| Attribute Name | Description |
|---|---|
| Type : ExceptionType | |
| Day : Day |
ExceptionalDays
| Attribute Name | Description |
|---|---|
| List of ExceptionalDay : ExceptionalDay (optional) |
ExceptionType
An exception of a recurrence rule can add, delete or override on the events.| Value Name | Description |
|---|---|
| Overwrite | |
| Add | |
| Delete |
Genre
A Genre is a top category of the events by thematic. Music, Theater, Dance, etc.| Attribute Name | Description |
|---|---|
| Id : string | |
| Name : string (optional) |
GenreIds
| Attribute Name | Description |
|---|---|
| List of GenreId : string (optional) |
Highlight
Highlight's are the events that the content provider emphasizes The highlights can be national, regional or by genre| Value Name | Description |
|---|---|
| National | |
| Regional | |
| Genres |
Highlights
| Attribute Name | Description |
|---|---|
| List of Highlight : Highlight |
IGACRating
IGAC is a Portuguese authority that has as its task auditing the performance of cultural events and is an organically integrated entity under the Portugal Ministry of Culture, ensure the safety of performing arts, promote and defend the authors, classify and authenticate and cultural content. IGAC rating is the outcome of IGAC events classification. IGAC classify the event having into account if the contents are suitable for the individual age.NOTE:Not all the events have IGAC classification because they are out of IGAC classification scope Individuals with equal or more than 4 years old (M04)| Value Name | Description |
|---|---|
| Undefined | |
| M04 | |
| M06 | |
| M12 | |
| M16 | |
| M18 |
IGACRatings
| Attribute Name | Description |
|---|---|
| List of IGACRating : IGACRating |
Language
ListOfContributorRole
| Attribute Name | Description |
|---|---|
| ContributorRoles : ArrayOfContributorRole | |
| PaginationDetails : PaginationDetails |
ListOfEvent
| Attribute Name | Description |
|---|---|
| Events : ArrayOfEvent | |
| PaginationDetails : PaginationDetails |
ListOfGenre
| Attribute Name | Description |
|---|---|
| Genres : ArrayOfGenre | |
| PaginationDetails : PaginationDetails |
ListOfLanguage
| Attribute Name | Description |
|---|---|
| Languages : ArrayOfLanguage | |
| PaginationDetails : PaginationDetails |
ListOfTag
| Attribute Name | Description |
|---|---|
| Tags : ArrayOfTag | |
| PaginationDetails : PaginationDetails |
ListOfTarget
| Attribute Name | Description |
|---|---|
| Targets : ArrayOfTarget | |
| PaginationDetails : PaginationDetails |
ListOfType
| Attribute Name | Description |
|---|---|
| Types : ArrayOfType | |
| PaginationDetails : PaginationDetails |
ListOfVenue
| Attribute Name | Description |
|---|---|
| Venues : ArrayOfVenue | |
| PaginationDetails : PaginationDetails |
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) |
LocationIds
| Attribute Name | Description |
|---|---|
| List of LocationId : string (optional) |
LocationMetadata
| Attribute Name | Description |
|---|---|
| Provider : string | |
| TrustLevel : string (optional) | |
| ISP : string (optional) |
Media
Month
This type is used to define in which month of the year an event will occur.| Value Name | Description |
|---|---|
| January | |
| February | |
| March | |
| April | |
| May | |
| June | |
| July | |
| August | |
| September | |
| October | |
| November | |
| December |
MonthDay
This type is used to define in which day of the month an event will occur.| Value Name | Description |
|---|---|
| One | |
| Two | |
| Three | |
| Four | |
| Five | |
| Six | |
| Seven | |
| Eight | |
| Nine | |
| Ten | |
| Eleven | |
| Twelve | |
| Thirteen | |
| Fourteen | |
| Fifteen | |
| Sixteen | |
| Seventeen | |
| Eighteen | |
| Nineteen | |
| Twenty | |
| TwentyOne | |
| TwentyTwo | |
| TwentyThree | |
| TwentyFour | |
| TwentyFive | |
| TwentySix | |
| TwentySeven | |
| TwentyEight | |
| TwentyNine | |
| Thirty | |
| ThirtyOne |
Order
| Value Name | Description |
|---|---|
| Ascendant | |
| Descendant |
OrderBy
| Value Name | Description |
|---|---|
| StartDate | |
| EndDate | |
| EventName | |
| DistrictName | |
| MunicipalityName | |
| ParishName | |
| EventGenre | |
| EventType | |
| VenueName |
Ordering
PaginationDetails
| Attribute Name | Description |
|---|---|
| CurrentPage : int | |
| RecordsPerPage : int | |
| RecordsTotal : int |
PremiereFilter
| Attribute Name | Description |
|---|---|
| LocationIds : LocationIds (optional) | |
| VenueIds : VenueIds (optional) | |
| GenreIds : GenreIds (optional) | |
| TypeIds : TypeIds (optional) | |
| TargetIds : TargetIds (optional) | |
| IGACRatings : IGACRatings (optional) | |
| Tags : Tags (optional) |
PremiereRequestV2
| Attribute Name | Description |
|---|---|
| LanguageId : string (optional) | |
| IncludeDetails : boolean | |
| EventCorrelationId : string (optional) | |
| Filters : ArrayOfPremiereFilter (optional) | |
| Order : Ordering | |
| PageNumber : int | |
| RecordsPerPage : int |
Recurrence
Recurrence is a set of rules relating to time of an event. Defines that an event will always occur with these rules. For example an event will always occur in the second week of the month on a Friday, except in February that will not happen.| Attribute Name | Description |
|---|---|
| Rules : Rules | The set of rules for the event. It must be set at least one. |
| Days : Days | The days that will fulfill the rules. |
| ExceptionalDays : ExceptionalDays (optional) | The days that break the rules. |
RecurrenceRule
This type is used to define the recurrency in which a rule will occur.| Value Name | Description |
|---|---|
| Daily | |
| Weekly | |
| Monthly | |
| Annual | |
| Biannual | |
| Semiannual |
Rules
| Attribute Name | Description |
|---|---|
| List of RecurrenceRule : RecurrenceRule (optional) |
Schedule
Is the date time definition when an event occurs.| Attribute Name | Description |
|---|---|
| TimeZoneOffset : TimeZoneOffset | The time zone that matches the date and time. |
| StartDate : dateTime | When the event begins. |
| EndDate : dateTime (optional) | When the event ends. |
| Recurrence : Recurrence (optional) | If the Recurrence is set the next element (Days) must no be defined. This element is used to defined the event recorrency schedule. |
| Days : Days (optional) | In a schedule it may be not possible to extract a pattern/recorrence. Therefore, this element the expresses imperatively when an event occurs. |
Tag
The events have tags that aggregate them horizontally. Festival cycle, experimental, etc.| Attribute Name | Description |
|---|---|
| Name : string | |
| OccurrencesTotal : int |
Tags
| Attribute Name | Description |
|---|---|
| List of Tag : string (optional) |
Target
Target is the classification of the content provider that has into account the content age target. 3-6 event is proper to individuals that his age is between three and six years old Family event is suitable to family gatherings| Attribute Name | Description |
|---|---|
| Id : string | |
| Name : string (optional) |
TargetIds
| Attribute Name | Description |
|---|---|
| List of TargetId : string (optional) |
Timeframe
Is a time span where an event will occur.| Attribute Name | Description |
|---|---|
| StartTime : dateTime | |
| EndTime : dateTime (optional) | |
| Duration : int (optional) |
Timeframes
| Attribute Name | Description |
|---|---|
| List of Timeframe : Timeframe (optional) |
TimeZoneOffset
A time zone is a region on Earth, more or less bounded by lines of longitude, that has a uniform, legally mandated standard time, usually referred to as the local time. By convention, the 24 main time zones on Earth compute their local time as an offset from UTC (Coordinated Universal Time). Local time in each time zone is UTC plus the current time zone offset for the location in question.| Value Name | Description |
|---|---|
| UTCMinus12 | |
| UTCMinus11 | |
| UTCMinus10 | |
| UTCMinus9_30 | |
| UTCMinus9 | |
| UTCMinus8 | |
| UTCMinus7 | |
| UTCMinus6 | |
| UTCMinus5 | |
| UTCMinus4_30 | |
| UTCMinus4 | |
| UTCMinus3_30 | |
| UTCMinus3 | |
| UTCMinus2 | |
| UTCMinus1 | |
| UTC | |
| UTCPlus1 | |
| UTCPlus2 | |
| UTCPlus3 | |
| UTCPlus3_30 | |
| UTCPlus4 | |
| UTCPlus4_30 | |
| UTCPlus5 | |
| UTCPlus5_30 | |
| UTCPlus5_45 | |
| UTCPlus6 | |
| UTCPlus6_30 | |
| UTCPlus7 | |
| UTCPlus8 | |
| UTCPlus8_45 | |
| UTCPlus9 | |
| UTCPlus9_30 | |
| UTCPlus10 | |
| UTCPlus10_30 | |
| UTCPlus11 | |
| UTCPlus11_30 | |
| UTCPlus12 | |
| UTCPlus12_45 | |
| UTCPlus13 | |
| UTCPlus14 |
Type
A Type is a fine-grained category of the events by specialization of the Genre. Types are under the context given by the Genre. Genre: Music; Types: Pop/Rock, Contemporary, Hispanic, Electronic / Dance, Hip-Hop, etc.| Attribute Name | Description |
|---|---|
| Id : string | |
| Name : string (optional) |
TypeIds
| Attribute Name | Description |
|---|---|
| List of TypeId : string (optional) |
Venue
Venue is the place where the event occurs georeferenciated by SAPO GIS Service. A stadium, a theater, etc.| Attribute Name | Description |
|---|---|
| Id : string | |
| Name : string | |
| Contact : Contact (optional) | |
| Location : Location (optional) | |
| Address : string (optional) | |
| ZipCode : string (optional) | |
| ZipCodeSufix : string (optional) | |
| Description : string (optional) | |
| Media : ArrayOfMedia (optional) |
VenueIds
| Attribute Name | Description |
|---|---|
| List of VenueId : string (optional) |
VenueRequest
| Attribute Name | Description |
|---|---|
| LocationIds : LocationIds (optional) | |
| SearchText : string (optional) | |
| PageNumber : int | |
| RecordsPerPage : int |
WeekDay
This type is used to define in which day of the week an event will occur.| Value Name | Description |
|---|---|
| Monday | |
| Tuesday | |
| Wednesday | |
| Thursday | |
| Friday | |
| Saturday | |
| Sunday |
WeekInMonth
This type is used to define the week of the month when an event will occur.| Value Name | Description |
|---|---|
| One | |
| Two | |
| Three | |
| Four | |
| Five |
GIS Entities
ArrayOfCountry
ArrayOfDistrict
| Attribute Name | Description |
|---|---|
| List of District : District (optional) |
ArrayOfMunicipality
| Attribute Name | Description |
|---|---|
| List of Municipality : Municipality (optional) |
ArrayOfParish
| Attribute Name | Description |
|---|---|
| List of Parish : Parish (optional) |
District
| Attribute Name | Description |
|---|---|
| DistrictId : string (optional) | |
| DistrictName : string (optional) | |
| Latitude : float (optional) | |
| Longitude : float (optional) | |
| Municipalities : ArrayOfMunicipality (optional) |
Municipality
| Attribute Name | Description |
|---|---|
| MunicipalityId : string (optional) | |
| MunicipalityName : string (optional) | |
| Latitude : float (optional) | |
| Longitude : float (optional) | |
| UrlForm : string (optional) | |
| Parishes : ArrayOfParish (optional) |
Parish
| Attribute Name | Description |
|---|---|
| ParishId : string (optional) | |
| ParishName : string (optional) | |
| Latitude : float (optional) | |
| Longitude : float (optional) |