Presentation is loading. Please wait.

Presentation is loading. Please wait.

Aleks Drozdov Enterprise Architect What is an API and what might the Discovery API mean for services contributing data to Discovery.

Similar presentations


Presentation on theme: "Aleks Drozdov Enterprise Architect What is an API and what might the Discovery API mean for services contributing data to Discovery."— Presentation transcript:

1 Aleks Drozdov Enterprise Architect What is an API and what might the Discovery API mean for services contributing data to Discovery

2 Agenda API and Data Discovery architecture Getting data into Discovery Discovery data structure Discovery API (Scenarios) Next steps

3 API and Data Application Programming Interface A language and message format used by an application program to communicate with the operating system or some other control program such as a database management system (DBMS) or communications protocol. Personal computer ApplicationOperating System UI API

4 Web API When used in the context of web development, an API is typically defined as a set of Hypertext Transfer Protocol (HTTP) request messages. Response messages, which is usually in an Extensible Markup Language (XML) or JavaScript Object Notation (JSON) format. While "Web API" is virtually a synonym for web service, the recent trend (so-called Web 2.0) has been moving away from Simple Object Access Protocol (SOAP) based services towards more direct Representational State Transfer (REST) style communications. Source: Wikipedia Personal computer Application Discovery System Web browser API

5 Data Explosion in the amount of data It is common to mashup data from a number of sources User contributed data Since ‘80s processor speed increas of 360 RAM price – from $1000/MB to $25/GB Reduction in RAM size 1956 disk drive -5MB -Refrigerator size -250 pounds

6 Discovery Architecture

7 System User Interface Object Data Store Datasets and data transformations

8 Getting data into Discovery

9 Data import - databases Relational (SQL) databases Nonrelational Object Data Store Data denormalisation/ Transformation Text input EXCELTXTCSV XML

10 Data import – user

11 Discovery data model

12 Core of the Discovery is an Information Asset object. Information Asset models The National Archives data in the hierarchical way and uses Collections and parent-child relationship. Properties of the Information Asset object don’t change across different data sets and hierarchies. Different data sources are using different schemas, which can lead to missing properties in the Information Assets. Still, the structure of the Information Asset stays unchanged. The main challenge in the design Information Asset object is to find minimum common set of properties which will work across all data sources. Information Asset

13 Discovery data - Search

14 Discovery data - Browse

15 Discovery data - Details

16 Discovery API

17 UriMethodDescription informationasset/{id}GETService at DiscoveryAPI/[xml][json]informationasset/{ID} children/{id}/{page}GETService at DiscoveryAPI/[xml][json]children/{ID}/{PAGE} totalchildren/{id}GETService at parent/{id}GETService at DiscoveryAPI/[xml][json]Parent/{ID} siblings/{id}/{PAGE}GETService at search/{PAGE}?{query}GETService at /{PAGE}/query={QUERY};all={ALLWORDS};exact={EXACTPHRASE};collection={DEPARTME NTS}&startDate={STARTDATE}&endDate={ENDDATE};formerRef={FORMERREFERENCE} Operations at Documentation:

18 Information Asset C

19 API XML response { "assetView" : { "IAID" : "C ", "SourceLevelId" : 7, "ParentIAID" : "C ", "Reference" : "1", "CatalogueId" : , "Language" : "English", "LegalStatus" : "Public Record(s)", "FormerReferenceDep" : "", "FormerReferencePro" : "", "Title" : "", "MapDesignation" : "", "CreatorName" : [ ], "CoveringDates" : "1853 October 8", "PhysicalDescriptionExtent" : "", "PhysicalDescriptionForm" : "", "Dimensions" : "", "MapScaleNumber" : 0, "PhysicalCondition" : "", "HeldBy" : [ { "Corporate_Body_Name_Text" : "The National Archives, Kew" } ], C C English Public Record(s) 1853 October 8 0 The National Archives, Kew XML JSON

20 Scenarios

21 Scenario – navigating hierarchy C3735 C 203 Chancery: Petty Bag Office: Various Certificates Chancery: Petty Bag Office: Various Certificates. Miscellaneous returns and certificates in the custody of the Petty Bag Office, including inquisitions and presentments by jurors concerning the killing, sale or eating of meat in Lent; records of the appointment of collectors of subsidies, possibly connected with their own tax liabilities; documents relating to the sequestration of estates of delinquents; certificates confirming the surrender of offices; certificates recording the oath of allegiance, supremacy and abjuration sworn by attornies; certificates naming those who failed to swear the oaths required by the Security of the Sovereign Act 1714; certificates concerning concealed deaths under the Cestui que Vie Act 1707; certificates attesting that members of Parliament met the property qualification required by the Parliament Act C10106 Taxation C10039 Food and drink /1/C43/C598/C3735 C Search for Information Asset

22 Scenario – navigating hierarchy 109 Get total number of children

23 Scenario – navigating hierarchy 4f24d14055e0f a C C Description available at other catalogue level true 0 Get all children

24 Scenario - search Build API request Send request to API Receive list of results Page through results Retrieve Information Asset data 53 C DO 119/1373 Ritual murder and <span class="highlight">witchcraft</span>; Rex vs Chiefs Bereng and Gabashane and others High Commissioner for South Africa, and High Commissioner for Basutoland, the Bechuanaland Protectorate and Swaziland, and UK High Commissioner for the Union of South Africa: Correspondence. Basutoland. Ritual murder and <span class="highlight">witchcraft</span>; Rex vs Chiefs Bereng and Gabashane and others. C10125 Africa C10117 Witchcraft C10023 Crime II 066/1/C86/C495/C6128/C51353/0/C DO

25 Next steps

26 Discovery Platform External Data Data Import API Data Export API External Data Data sharing and reuse User participation API

27 Thank you!


Download ppt "Aleks Drozdov Enterprise Architect What is an API and what might the Discovery API mean for services contributing data to Discovery."

Similar presentations


Ads by Google