NUBWiki - Recent changes [en]

Uitleg Uitgelichtpagina

2012-05-16T10:38:44Z

Productpagina Uitleg

2012-05-16T10:36:54Z

Uitleg nieuwsitem

2012-05-16T10:35:28Z

Feed API 3.1

2012-05-14T13:21:16Z

filters in ps4:

Feed API 4.0

2012-05-14T08:41:24Z

Search resources:

Feed API 3.1

2012-05-11T13:14:28Z

wiki key

Feed API 3.1

2012-05-11T13:12:55Z

opzet documentatie gewijzigde situatie nubxml

New page

Draft

== NUB XML ==
All responses from the Feed API v3.0 uses a XML format known as the NUB XML. The following is a summary of the format:
<nubxml>
<suggestion>...</suggestion>
<events start=... rows=... numfound=...>
<event eventcidn=... productioncidn=... datecreated=... datechanged=...>
...
</event>
</events>
<facets>
<facet name=... param=...>
...
</facet>
</facets>
</nubxml>

Contained in the XML are:

<ul><li> [[#Spelling_Suggestions]]

</li><li> Events found by the search
</li><li> [[Search Facets]]
</li></ul>
<a name="Searching_for_Events"></a>

<h2> Searching for Events </h2>
Searching for events is done through HTTP GET requests to a REST interface. The following is a description of the interface.

<a name="Requests"></a><h3> Requests </h3>
Base URL: http://test.publisher.uitburo.nl/agenda/search.do

Parameters:
Let op!: Alle parameters zijn hoofdlettergevoelig

Parameters:
{| border="1" cellpadding="5" cellspacing="0"
| Parameter name
| input type
| Explanation
| Part of
| Example
|-
| key
| xs:string
| All requests must include the access key for your account. This key will be used to retrieve your account and apply any account specific filtering during searches
| Core
| http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725
|-
| locale
| xs:string
| The Feed API v3.0 supports searching in multiple locales. This parameter defines both the locale for searching, and the locale for the results. Note, the search is applied against the index for the locale, so only those events which have a translation for the specified locale, will be considered. See [[#Locales]] for more information.
| Core
| http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&locale=fy_NL
|-
| start
| xs:int
| Defines the starting index for the current page of search results. A search can potentially result in thousands of results. Returning this all in one request would be very inefficient, therefore the Feed API requires users to 'page' through results. The start parameter, in combination with the rows parameter defined below, allows control over the page size and which page to retrieve. Note, the start value is an offset from 0, rather than a page number.
| Core
| Assuming the default rows of 10, to retrieve the second page of results: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&start=10
|-
| rows
| xs:int
| Defines the number of results to return in the current request. This can be considered as the page size, and for most users it makes sense to use the same number for each request. Values in excess 1000 will take some time to respond.
| Core
| To define a page size of 12: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&rows=12
|-
| text
| xs:string
| Text to query events for. This is perhaps the most important parameter, as it is used to find events and will influence their relevancy score. The value will be used to query a number of different fields in events. '''Case is ignored'''.
| Searchable
| To find Shakespearean events: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&text=shakespeare
|-
| locationText
| xs:string
| Text used to find events that are occurring in a certain city. Although this is a free text search like the text parameter, it does not influence the relevancy score of results. Case is ignored.
| Searchable
| To find events in Venlo: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&locationText=Venlo
|-
| location
| xs:string
| Exact name of a location that events must be occurring at. Here, location refers to the name of the location, such as Centrale Bibliotheek. While it is possible to include the location in the text parameter, the text parameter is a free text search. This is a filter, meaning it must match the location title of the event exactly and has no influence on relevancy scoring. The source of these values are most likely the location facet described below. Case is important.
| Searchable
| To find events occurring at the Centrale Bibliotheek: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&location=Centrale%20Bibliotheek
|-
| headGenre
| xs:string
| Filters the events to only those that have the head genre. Note this is a case sensitive exact match. Can be specified multiple times to select events which have head_genre_1 AND head_genre_2 AND ... head_genre_n
| Searchable
| To find events with the head genres Dans AND Film: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&headGenre=Dans&headGenre=Film
|-
| Head genre OR
|
| To combine the Headgenre filters to form a logical operator OR, use headGenreOperatorAnd=false as parameter.
| Searchable
| To find events with the head genres Dans OR Film: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&headGenre=Dans&headGenre=Film&headGenreOperatorAnd=false
|-
| subGenre
| xs:string
| Filters the events to only those that have the sub genre. Note this is a case sensitive exact match. Can be specified multiple times to select events which have sub_genre_1 OR sub_genre_2 OR sub_genre_n
| Searchable
| To find events with the sub genres Kamermuziek or SpeelFilm: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&subGenre=Kamermuziek&subGenre=SpeelFilm
|-
| period
| xs:string
| Named period of time which events must start during. See [[#Periods]] for a list of the named periods and what they resolve too.
| Searchable
| To find all events today: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&period=TODAY
|-
| periodStart
| xs:date-timestamp Y-mm-ddThh:mm:ssZ
| Defines the start of the period in which events must start during. See [[#Dates_.26_Times]] for the datetime format.
| Searchable
| To find all events starting after March 15 2010: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&periodStart=2010-04-15T00:00:00Z
|-
| periodEnd
| xs:date-timestamp Y-mm-ddThh:mm:ssZ
| Defines the end of the period in which events must start during. See [[#Dates_.26_Times]] for the datetime format.
| Searchable
| To find all events starting before September 15 2010: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&periodEnd=2010-09-15T00:00:00Z
|-
| gratis
| xs:bit (0 or 1)
| Defines whether events should be noted as gratis or not. Possible values 1 or 0. When omitted, no filtering is applied.
| Searchable
| To find gratis events: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&gratis=1
|-
| regionId
| xs:int
| ''[depricated]'' Defines which region events must be occurring in (or the responsibility of). See [[#Regions]] for the list of region ids. When omitted, no region filtering is applied
| Searchable
| To find events in Amsterdam: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&regionId=1
|-
| lmts
| xs:bit (0 or 1)
| Defines whether events should have Last Minute Ticket Shop (LMTS) prices. Possible values of 1 or 0. When omitted, no filtering is applied.
| Searchable
| To find LMTS events: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&lmts=1
|-
| changedSince
| xs:date-timestamp Y-mm-ddThh:mm:ssZ
| Defines that events must have changed after the given date Date. See [[#Dates_.26_Times]] for the date format.
| Searchable
| To find all events that have changed after March 15 2010: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&changedSince=2010-04-15T00:00:00Z
|-
| hasMedia
| xs:bit (0 or 1)
| Defines whether events should have media associated with them. Note, this is only media related to the event itself, not the location where the event is occurring. Possible values of 1 or 0. When omitted, no filtering is applied
| Searchable
| To find events with media: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&hasMedia=1
|-
| sort
| xs:string
| Defines the kind of sorting that should be applied to the search results. By default, search results are sorted by their relevancy score descending, meaning the most relevant results are first. By setting this parameter, different sorting will occur. Possible values are:
<ol>
<li> startdatetime: Sorts by the start datetime of events</li>
<li> title: Sorts by the title of the events, lexographically</li>
<li> random: By providing providing a seed value by adding &seed=[random value(number/letter)], it is possible to sort the events randomly. Use the same value to ensure the same random sorting is applied as you page through the results. note: this means a new random order requires a new 'seed' to be presented to the server.</li>
</ol>
| Searchable
| To sort events by their title: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&sort=title
|-
| direction
| xs:string (asc or desc)
| Defines the direction of the sort specified by the sort parameter. Two possible values, "asc" for ascending, and "desc" for descending. When omitted, descending sorting is applied.
| Searchable
| To sort events in a descending order: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&sort=title&direction=desc
|-
| eventId
| xs:string
| Chooses an event with a specific event ID. Can be specified multiple times to select multiple events. Maximum number of values that can be defined is 1024.
| Searchable
| To choose the event with eventId 2009-A-001-123456: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&eventcidn=2009-A-001-123456
|-
| productioncidn
| xs:string
| Chooses events with a specific production cidn. Can be specified multiple times to select events with different production cidns. Maximum number of values that can be defined is 1024.
| Searchable
| To choose events with the production CIDN 2009-P-001-123456: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&productioncidn=2009-P-001-123456
|-
| locationcidn
| xs:string
| Chooses events with a specific location cidn. Can be specified multiple times to select events with different location cidns. Maximum number of values that can be defined is 1024.
| Searchable
| To choose events with the location CIDN 2009-L-001-123456: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&locationcidn=86542ae3-9c5a-413c-bd78-66e23a3096c4
|-
| seed
| xs:string
| The seed parameter can be used to identify a randomized set. In future requests, the same set can be retrieved by using the same seed paramenter. When requesting a subset, like the first 10 items, of a randomized set, it is possible to request for the second 10 items (10 to 20) of that same randomized set.
| Searchable
| Seed example: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&seed=alpha
|-
| metaStatus
| xs:string
| A production is equiped with a certain metastatus. See [[#MetaStatus]] for a list. This metastatus must be one of the following options:
<ol>

<li> active: This production is active</li>
<li> deleted: This production has been deleted</li>
<li> duplicate: This production is considered to be duplicate</li>
<li> incomplete: This production is considered to be incomplete</li>

<li> party: This production uses an party template</li>
<li> production: This production uses a production template</li>
<li> location: This production uses a location template</li>
</ol>
| Core
| example: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&metaStatus=deleted
|-
| source
| xs:string
| The source of the event is considered to be a party or organisation wherefrom the author has published an event.
| Core
| example when search by source called alpha: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&source=alpha
|-
| owner
| xs:string
| The author of the event, who added the event from an organisation or party (source)
| Core
| example when searching for an owner called willem: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&owner=willem
|-
| type
| xs:string
| An event has a certain type and can be choosen as a string
| Searchable
| example when search for event types like Festivals: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&type=Festival
|-
| eventStatus
| xs:string
| An event has a status as well. See [[#EventStatus]] for a list.
<ol>
<li> normal: This event is a normal event</li>
<li> postponed: This event has been postponed</li>
<li> cancelled: This event has been cancelled</li>
</ol>
| Searchable
| example for previewing events with an eventStatus postponed: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&eventStatus=postponed
|-
| postalCode
| xs:string
| PC location
| Searchable
| example for searching events with postalcode 1234AB: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&postalCode=1234AB
|-
| locationTags
| xs:string
| tags for location
| Searchable
| example with locationTags Amsterdam: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&locationTags=Amsterdam
|-
| partycidn
| xs:string
| The cultural ID number of a certain party (e.g. hamlet, mozart) can be used to get an event
| Searchable
| example for previewing events with partycidn 12345: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&partycidn=12345
|-
| priceTag
| xs:string
| The category of prices according to ticketshops
| Searchable
| example for showing events by priceTag: http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&priceTag=12345
|-
| uitgaves
| xs:string
| It is possible to select by "uitgaves" (dutch for editions/publications)
| Core
| example for showing events by with "uitgaves" like amsterdam http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&uitgaves=Amsterdam
|-
| parent
| xs:string
| It is possible to show events by using the parent eventid
| Searchable
| example for previewing events by using the parentid eventid http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&parent=1234
|-
| age
| xs:int (range)
| Events with certain age-constraints can be applied with a range from 18 to 99
| Searchable
| example for showing events with an age within the range 16-21 http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&age=16:21
|-
| price
| xs:double (range)
| A price range for events as a double.
| Searchable
| example for showing events with prices within the range 12.50 to 19:95 http://test.publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&price=12.50:19:95
|-
| type
| xs:string
| The type of event you ask for.
| Searchable
| example for showing events that are typed to be festivals http://publisher.uitburo.nl/agenda/search.do?key=a9d8fc27e5cbde7bca8402b53fe5a725&type=Festival
|-
|}

Note, events which have completed in the past cannot be requested and will not be included in the search results. Such requests will not result in an error, just an empty result list.

<a name="Examples"></a>

== todo ==
== filters in ps4 ==
locale -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&locale=nl_NL
start -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&start=2
rows -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&rows=3
location -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&location=Nieuwe+Luxor+Theater+Rotterdam
locationText -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&locationText=Luxor
headGenre -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&headGenre=Dance
subGenre -> IS NIET BESCHIKBAAR
period -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&period=THISWEEKEND (LET OP THIS WEEKEND IS NIEUW!!!)
periodStart -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&periodStart=2012-05-06T10:00:00Z
periodEnd -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&periodEnd=2012-05-05T10:00:00Z
gratis -> FILTER gedaan, INDEX nog niet. Weet niet hoe het veld afgeleid moet worden.
regionId -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&regionId=1
lmts -> FILTER gedaan, INDEX nog niet. Weet niet hoe het veld afgeleid moet worden.
changedSince -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&changedSince=2012-05-06T10:00:00Z
changedTill -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&changedTill=2012-05-06T10:00:00Z (BONUS ;-)
sort -> default PS4 functionaliteit. sort=headGenre+asc (om de richting aan te geven)
direction -> zie sort
eventId -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&eventId=3bbbd300-765a-461e-9469-afea23115207-nl_NL
productioncidn -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&productioncidn=186e44cc-d908-4077-95b3-108bab1ec9d6
locationscidn -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&locationcidn=8d7bfc71-1264-42ee-ae74-7c52ec25be4e
metaStatus -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&metaStatus=active
type -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&type=performance
uitgaves -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&uitgaves=Amsterdam
parent

== kleinere issues ==
maximum resultset ROWS=500
orange11 XSD's checken en hier opnemen.
Vertellen over nieuwe url's en waarom deze wijziging is gedaan
alle ongewijzigde gegevens uit de 3.0 overnemen
tijdens de overgang versie 3.0 en 3.1 naast elkaar tonen, na de overgang 3.0 weglaten.

@@ Line 31: / Line 31: @@
 Let op, de einddatum is de dag dat de pagina van de site verdwijnt, dus stel je wilt iets tot en met 15-05-2012 erop willen laten staan dan vul je bij einddatum in 16-05-2012.
-===== Koppeling (Deekverzameling): =====
+===== Koppeling (Deelverzameling): =====
 Dit is een van de belangrijkste velden, hiermee voeg een deelverzameling toe aan het uitlicht item. Een deelverzameling is een verzameling van events, deze moet appart worden aangemaakt. Waneer een deelverzameling is aangemaakt kun je events daar aan toevoegen door naar het event te gaan en daar de juiste deelverzameling te selecteren en op toevoegen te klikken. Wanneer je een deelverzamling wilt aanmaken wordt dit een subset genoemd.
 ===== Additional (Caroussel): =====

@@ Line 18: / Line 18: @@
 * "URL path settings": Hier kun je eventueel een alternatieve URL invoeren, standaard verschijnen producten onder /extra/<title>.
 * "Koppeling": Selecteer hier het [[Eersteversie#Webform | formulier]] dat je wilt koppelen aan het product.
 * "Publishing options" Selecteer deze optie om de pagina zichtbaar te maken voor gebruikers.
 Kies '''opslaan''', en klaar!

← Older revision		Revision as of 10:35, 16 May 2012
Line 6:		Line 6:

	* URL path settings: staat automatisch op nieuws/[Titel]		* URL path settings: staat automatisch op nieuws/[Titel]
		+
		+	* Meta Tags: Metatags zijn bedoeld om (niet normaal zichtbare) informatie op te nemen over de inhoud van een website of een webpagina. Op deze manier kunnen de zoekresultaten worden verbeterd.

	* Koppeling: Functie werkt niet, wanneer je een link wil toevoegen moet je dit in de body doen. (selecteer de text waaraan je een link wilt koppelen, selecter boven het tekst vak de [[Image:koppeling.png]] button en vul de Link URL in, met title wordt bedoeld de text die tevoorschijn komt wanneer de gebruiker zijn muis erboven laat zweven.		* Koppeling: Functie werkt niet, wanneer je een link wil toevoegen moet je dit in de body doen. (selecteer de text waaraan je een link wilt koppelen, selecter boven het tekst vak de [[Image:koppeling.png]] button en vul de Link URL in, met title wordt bedoeld de text die tevoorschijn komt wanneer de gebruiker zijn muis erboven laat zweven.

@@ Line 177: / Line 177: @@
 == Search resources==
-The Publishing Server 4.0 has a search entry point, which means a central place to ask questions to the platform. The search result is a list with links to several resources on the platform. All resource filters can be used with the search entry. Below an example of searching resources with locale en_UK.
+The Publishing Server 4.0 has a search entry point, which means a central place to ask questions to the platform. The search result is a list with links to several resources on the platform. All resource filters can be used with the search entry. Below an example of searching resources with locale en_US.
-  GET /search?locale=en_UK HTTP/1.1
+  GET /search?locale=en_US HTTP/1.1
 This will result in:

@@ Line 302: / Line 302: @@
 == todo ==
 == filters in ps4 ==
-Moet er een nieuwe key komen voor deze wiki? die gelijk is aan de originele key? ivm gebruikers van de wiki key?
+Er moet een nieuwe key komen voor deze wiki, die gelijk is aan de originele key? onderstaande key is een admin key
 locale -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&locale=nl_NL
@@ Line 327: / Line 327: @@
 type -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&type=performance
 uitgaves -> http://accept.ps4.uitburo.nl/agenda/search.do?key=d17b95e012d21ccb32a40ee6b8ac6907&uitgaves=Amsterdam
 parent
 == kleinere issues ==