info:sid/localhost:CollectionWikiPages:WikiDApis info:sid/localhost:CollectionWikiPages CollectionWikiPages http://alcme.oclc.org:80/wikid/search/WikiDb.localhost WikiDApis display Wiki Pages userAssigned mailto:jyoung@oclc.org no info:sid/localhost:CollectionSimpleSchemas:wiki info:sid/localhost:CollectionExternalSchemas:xhtml info:sid/localhost:CollectionExternalSchemas:xhtml 1.1 1 815zzo 300 http://www.oclc.org/schemas/WikiRepository xml http://alcme.oclc.org:80/wikid/docs/WikiRepository info:sid/localhost:CollectionWikiPages:WikiDApis anonymous CollectionWikiPages 2006/04/28/10 inf_3asid_2flocalhost_3aCollectionWikiPages_3aWikiDApis_5f20060428102931020 text/xml CollectionWikiPages:WikiDApis 2005-12-08 2006-04-28 1 1.1 repos.hasDate = "hasdate" and oai.identifier exact "info:sid/localhost:CollectionWikiPages:WikiDApis" cql.any = huh? 1 1 xml default 2006-04-28 http://alcme.oclc.org:80/wikid/docs/WikiRepository/2006/04/28/10/inf_3asid_2flocalhost_3aCollectionWikiPages_3aWikiDApis_5f20060428102931020 = WikiD APIs = Here are descriptions and examples of various APIs into the WikiD system. == Update APIs == Please see WikiDUpdateApis for details. == Wiki API == This API is designed to mimic conventional wiki URLs. There are four possible variations: 1. <baseURL>: Refers to CollectionWikiPages:FrontPage (e.g. http://alcme.oclc.org/wikid/'''''') 1. <baseURL> + <Item''''''Id>: Refers to an item in CollectionWikiPages (e.g. http://alcme.oclc.org/wikid/FrontPage'''''') 1. <baseURL> + <Collection''''''Id> + ':' + <Item''''''Id> + ('?' <params>): Refers to an item in the specified collection (e.g. http://alcme.oclc.org/wikid/CollectionExternalSchemas:mets?action=edit'''''') 1. <baseURL> + <URI>: Refers to a resource that may or may not be resolvable by the WikiD installation (e.g. http://alcme.oclc.org/wikid/urn:ISBN:0123456789'''''') (Note that variant 1 is a shorthand for 2, 2 is a shorthand for 3, etc. Also note that "CollectionWikiPages:FrontPage" gets transformed into a URI behind the scenes: info:sid/localhost:CollectionWikiPages:FrontPage'''''') Key: * "<baseURL>" represents the baseURL of the WikiD context (e.g. http://alcme.oclc.org/wikid/'''''') * "<Collection''''''Id>" represents a collection existing within that WikiD installation * "<Item''''''Id>" represents an item in a collection. * "<params>" represents variable Wiki-style parameters == OpenURL 1.0 API == This is the OpenURL 1.0 API. * http://alcme.oclc.org/wikid/resolver * Note that Wiki-style requsts are immediately transformed into an OpenURL 1.0 equivalent and handed off to an internal resolver: http:''''''//alcme.oclc.org/wikid/resolver?url_ver=Z39.88-2004 &url_ctx_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Actx &ctx_enc=info%3Aofi%2Fenc%3AUTF-8 &rft_id=info%3Asid%2Flocalhost%3ACollectionExternalSchemas%3Amets &svc_dat=action%3Dedit &rfr_id=info%3Asid%2Foclc.org%3Areferrer%2FWikiD ** OpenURL 1.0 parameter breakdown: *** baseURL: http://alcme.oclc.org/wikid/resolver *** url_ver: Z39.88-2004 *** url_ctx_fmt: info:ofi/fmt:kev:mtx:ctx *** ctx_enc: info:ofi/enc:UTF-8 *** '''rft_id: info:sid/localhost:CollectionExternalSchemas:mets''' *** '''svc_dat: action=edit''' *** '''rfr_id: info:sid/oclc.org:referrer/WikiD''' == SRW/U API == This is the SRW/U API. * http://alcme.oclc.org/wikid/search/WikiDb.localhost == Service API (e.g. RSS and OAI) == This API is similar to the Wiki API except that "action=foo" gets represented as a ".foo" suffix. This was necessary because some processors (e.g. OAI harvesters) can't handle for former variation. * RSS ** http://alcme.oclc.org/wikid/service/CollectionWikiPages.rss ** Equivalent to: http://alcme.oclc.org/wikid/CollectionWikiPages?action=rss * OAI-PMH ** http://alcme.oclc.org/wikid/service/CollectionWikiPages.oai ** Equivalent to: http://alcme.oclc.org/wikid/CollectionWikiPages?action=oai == Raw content API == This API is similar to the Service API, except that the ".foo" extension gets interpreted as "action=raw&recordPrefix=foo" rather than "action=foo". Again, this is because some processors can't handle the parameterized version * http://alcme.oclc.org/wikid/raw/CollectionSimpleSchemas:wiki.xsd * Equivalent to: http://alcme.oclc.org/wikid/CollectionSimpleSchemas:wiki?action=raw&recordPrefix=xsd == unAPI API == All WikiD collections support unAPI (http://www.code4lib.org/specs/unapi/revision-1''''''). For example: * http://alcme.oclc.org/wikid/CollectionGsafd - Contains unAPI links in the HTML * http://alcme.oclc.org/wikid/unapi/CollectionGsafd - is the unAPI baseURL for CollectionGsafd * http://alcme.oclc.org/wikid/unapi/CollectionGsafd?uri=info:sid/localhost:CollectionGsafd:GSAFD000001 - returns a status-code 300 listing the available formats for an item in the collection * http://alcme.oclc.org/wikid/unapi/CollectionGsafd?uri=info:sid/localhost:CollectionGsafd:GSAFD000001&format=zthes - returns a zthes record for this item

WikiD APIs

Here are descriptions and examples of various APIs into the WikiD system.

Update APIs

Please see WikiDUpdateApis for details.

Wiki API

This API is designed to mimic conventional wiki URLs. There are four possible variations:
  1. <baseURL>: Refers to CollectionWikiPages:FrontPage (e.g. http://alcme.oclc.org/wikid/)
  2. <baseURL> + <ItemId>: Refers to an item in CollectionWikiPages (e.g. http://alcme.oclc.org/wikid/FrontPage)
  3. <baseURL> + <CollectionId> + ':' + <ItemId> + ('?' <params>): Refers to an item in the specified collection (e.g. http://alcme.oclc.org/wikid/CollectionExternalSchemas:mets?action=edit)
  4. <baseURL> + <URI>: Refers to a resource that may or may not be resolvable by the WikiD installation (e.g. http://alcme.oclc.org/wikid/urn:ISBN:0123456789)
(Note that variant 1 is a shorthand for 2, 2 is a shorthand for 3, etc. Also note that "CollectionWikiPages:FrontPage" gets transformed into a URI behind the scenes: info:sid/localhost:CollectionWikiPages:FrontPage)

Key:

OpenURL 1.0 API

This is the OpenURL 1.0 API. 
 http://alcme.oclc.org/wikid/resolver?url_ver=Z39.88-2004
 &url_ctx_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Actx
 &ctx_enc=info%3Aofi%2Fenc%3AUTF-8
 &rft_id=info%3Asid%2Flocalhost%3ACollectionExternalSchemas%3Amets
 &svc_dat=action%3Dedit
 &rfr_id=info%3Asid%2Foclc.org%3Areferrer%2FWikiD

SRW/U API

This is the SRW/U API.

Service API (e.g. RSS and OAI)

This API is similar to the Wiki API except that "action=foo" gets represented as a ".foo" suffix. This was necessary because some processors (e.g. OAI harvesters) can't handle for former variation.

Raw content API

This API is similar to the Service API, except that the ".foo" extension gets interpreted as "action=raw&recordPrefix=foo" rather than "action=foo". Again, this is because some processors can't handle the parameterized version

unAPI API

All WikiD collections support unAPI (http://www.code4lib.org/specs/unapi/revision-1). For example: