®                                                             Product ™                                        SSS MapServ...
Document HistoryRevision               Date                    History1                      5 MAY 11                Creat...
Trademarks, Patents and LicencesUnless otherwise stated, words and logos marked with ™ or ® are trademarks registered or o...
ContentsDocument History ....................................................................................................
1.           Purpose and Scope1.1.         PurposeThis guide briefly describes and illustrates how to use the SiRF Studio ...
2.            MapServer Server-side APIServer-side API has been developed using .NET framework. The API methods are expose...
2.2.         Mapping API2.2.1.       Get Dynamic Layer(s)2.2.1.1.     DescriptionGet dynamic layer-data as an image. It qu...
lines or not. This is only required for point-layers. Default                                                    value is ...
Document ReferencesDocument                                                                               ReferenceSiRF St...
Terms and DefinitionsBlueCore®                Group term for CSR’s range of Bluetooth wireless technology chipsBluetooth® ...
Upcoming SlideShare
Loading in …5
×

Csr template

805 views
724 views

Published on

Published in: Business, Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
805
On SlideShare
0
From Embeds
0
Number of Embeds
3
Actions
Shares
0
Downloads
6
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Csr template

  1. 1. ® Product ™ SSS MapServer Server-side API Specification Draft 1.0 Page 1 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  2. 2. Document HistoryRevision Date History1 5 MAY 11 Created in SiRF Template2 8 SEPT Created in CSR Template. Latest API updated.Contacts Product SSS MapServer Server-side API SpecificationGeneral information www.csr.comInformation on this product sales@csr.comCustomer support for this product www.csrsupport.comMore detail on compliance and standards product.compliance@csr.comHelp with this document comments@csr.com Page 2 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  3. 3. Trademarks, Patents and LicencesUnless otherwise stated, words and logos marked with ™ or ® are trademarks registered or owned by CSR plc and/or itsaffiliates.Select appropriate sentences based on product range from this listOther products, services and names used in this document may have been trademarked by their respective owners.The publication of this information does not imply that any licence is granted under any patent or other rights owned byCSR plc or its affiliates.CSR reserves the right to make technical changes to its products as part of its development programme. Product SSS MapServer Server-side API SpecificationWhile every care has been taken to ensure the accuracy of the contents of this document, CSR cannot accept responsibilityfor any errors.No statements or representations in this document are to be construed as advertising, marketing, or offering for sale in theUnited States imported covered products subject to the Cease and Desist Order issued by the U.S. International TradeCommission in its Investigation No. 337-TA-602. Such products include SiRFstarIII™ chips that operate with SiRF softwarethat supports SiRFInstantFix™, and/or SiRFLoc® servers, or contains SyncFreeNav functionality.Life Support Policy and Use in Safety-critical ComplianceCSR’s products are not authorised for use in life-support or safety-critical applications. Use in such applications is done atthe sole discretion of the customer. CSR will not warrant the use of its devices in such applications.Performance and ConformanceRefer to www.csrsupport.com for compliance and conformance to standards information. Page 3 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  4. 4. ContentsDocument History ...................................................................................................................................................................... 2Contacts ..................................................................................................................................................................................... 2Trademarks, Patents and Licences ............................................................................................................................................. 3Life Support Policy and Use in Safety-critical Compliance ......................................................................................................... 3Performance and Conformance ................................................................................................................................................. 3Contents .................................................................................................................................................................................... 4 Product SSS MapServer Server-side API Specification1. Purpose and Scope ............................................................................................................................................................ 5 1.1. Purpose ...................................................................................................................................................................... 5 1.2. Scope.......................................................................................................................................................................... 52. LMBinary APIs .................................................................................................................................................................... 5 2.1. Register Service Accessor for single service id ........................................................................................................... 6 2.2. Register Service Accessor for multiple service ids .......................................................Error! Bookmark not defined.Document References ............................................................................................................................................................... 9Terms and Definitions .............................................................................................................................................................. 10 Page 4 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  5. 5. 1. Purpose and Scope1.1. PurposeThis guide briefly describes and illustrates how to use the SiRF Studio Server MapServer API by describing each API methodthrough method definition, parameter details and short source code snippets. It includes details of both server as well asclient-side API. In addition, this guide offers some recommended practices for the API usage. By following these practices,the API can be utilized more efficiently and powerfully.1.2. ScopeThe document is intended as an aid for using the SiRF Studio Server MapServer API offering. Product SSS MapServer Server-side API Specification1.3. Abbreviations and Acronyms definitionAcronym DefinitionGA GeoAgentSS SiRF StudioPOI Point of InterestSSS SiRF Studio ServerSE Standard EditionURL Uniform Resource LocatorAPI Application Programming InterfaceJS JavaScript Page 5 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  6. 6. 2. MapServer Server-side APIServer-side API has been developed using .NET framework. The API methods are exposed through a .NET HTTP Handler. Allthese methods can be called through JavaScript using the MapServer Client-side API. The API provides the followingfunctionalities. 1. Mapping API 1.1. Get dynamic map layers, including history layer 1.2. Desktop component to create and cache custom map with user-defined layer settings Product SSS MapServer Server-side API Specification 2. Routing API 2.1. Get pre-defined named routes 2.2. Get shortest route 2.3. Save named routes 3. Query API 1.1. Query map-layers using attribute-filter and/or geometry-filter 3.1. Query the bounds of map-layers based on attribute-filter and/or geometry-filter2.1. Directory ReferenceMapServer Handler <MapServer-Virtual-Directory/MapServerHandler.ashx This is the primary access point for all API methods.Log files <MapServer-Virtual-Directory/logs/Config-file <MapServer-Virtual-Directory/web.configMap-files MapDotNet map-files can be accessed from MapDotNet Studio (Server URI: http://localhost/MapDotNetServerUX7.1) XML map-files can be accessed from <MapServer-Virtual-Directory/maps/ Page 6 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  7. 7. 2.2. Mapping API2.2.1. Get Dynamic Layer(s)2.2.1.1. DescriptionGet dynamic layer-data as an image. It queries layer-data, and returns layer-data as a binary image. Layer data-source anddisplay settings are read from the map. This method supports single as well as multiple layers. Product SSS MapServer Server-side API Specification2.2.1.2. Method Name/ Request TypeGetDynamicLayers/ GET2.2.1.3. Request ParamsThis API takes input in JSON format. The JSON string contains following 2 parameters.Parameter Type Description Sample ValueOperationName string Operation name GetDynamicLayersLayerDisplayInput string JSON string { containing MapName: ‘SiRFMap’, layer-display LayerNameList: [‘City_depot’, ‘City_BusStop’, parameters ‘City_History’], WhereClauseList: [ “ID>2”,”UNIQ_ID=’123’”, “USER_ID = ‘VT00001’”], ShowDirectionList: [false, false, true], MapExtent: {XMin: 77.22, YMin: 28.60, XMax: 77.23, YMax: 28.61}, ImageWidth: 1330, ImageHeight: 800, ImageDpi: 96, ImageFormat: PNG }LayerDisplayInput Params: Paramaters Type Description MapName string Map name containing data-source and display settings for given layer-names. This map can either be a MapDotNet map or an XML map-file stored in MapServer maps directory. LayerNameList [string] Array of layer-names. These layer-names are case-sensitive and should exist in the given map. WhereClauseList [string] (Optional) Array of where-clause to be applied to each layer- name. If where-clause is not provided, then where-clause is picked from map-file. If map-filter contains empty where- clause then entire layer-data is returned. ShowDirectionList [bool] (Optional) Array of ShowDirection status. ShowDirection indicates whether points in a layer should be connected by Page 7 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  8. 8. lines or not. This is only required for point-layers. Default value is false. MapExtent string (Optional) JSON string having attributes XMin, YMin, XMax, YMax. Layer-data will only be retrieved for given mapextent. If no mapExtent is given then it is picked from the MapServer config file. ImageWidth string Output image-width in pixels. Default is picked from the MapServer config file. ImageHeight string Output image-height in pixels. Default is picked from the MapServer config file. ImageDpi string (Optional) Output image-dpi. Default is picked from the MapServer config file. Product SSS MapServer Server-side API Specification ImageFormat string (Optional) Output image format. Currently supported types: PNG, JPEG, GIF. Default is picked from the MapServer config file.2.2.1.4. ResponseSuccess: Byte array containing layer(s) image.Error: Empty byte array Page 8 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  9. 9. Document ReferencesDocument ReferenceSiRF Studio Product Requirements Definition, Revision 1.0 02/20/2007 <Cognidox Ref>SiRF Studio Server: GeoAgent Component Requirements Specification Document, Revision0.3 02/07/2007Please add feedback on these documents in Cognidox or by emailing comments@csr.com. Product SSS MapServer Server-side API Specification Page 9 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com
  10. 10. Terms and DefinitionsBlueCore® Group term for CSR’s range of Bluetooth wireless technology chipsBluetooth® Set of technologies providing audio and data transfer over short-range radio connectionsCSR Cambridge Silicon RadioUniFi® Group term for CSR’s range of chips designed to meet IEEE 802.11 standards Product SSS MapServer Server-side API Specification Page 10 of 10© Cambridge Silicon Radio Limited 2011 CS-nnnnnn-SPP1xThis material is subject to CSR’s non-disclosure agreement www.csr.com

×