What do I do with the URL I create?

You can use the URL you've created to add a report to your site in a number of different ways. Below are some common examples:

Note: The API feature may not appear, depending on your subscription. For more information, contact your LexisNexis account representative.

Add the Report as a Web Part in SharePoint

Follow the steps below to add a report to any Microsoft Office SharePoint site for which you are an administrator.

  1. On the SharePoint site, click Site Actions > Edit Page.
  2. Click Add a Web Part.
  3. Select Page Viewer Web Part, then click Add.
  4. Within the new Page Viewer Web Part, click Edit > Modify Shared Web Part.
  5. Paste the URL for your report in the Link box.
  6. Specify the Web Part attributes (such as title, height, and width) using the Appearance options.
    Tip: You may want to enter a descriptive name for the report to override the default "Page Viewer Web Part" title. For example, "Recent IBM news" or "Top Companies in Computer Programming Services".
  7. Click OK.
  8. Click Exit Edit Mode.

The new Web Part appears on your SharePoint site, containing the report you created. The image below shows an example:

A report in Microsoft Office SharePoint

Embed the Report in a frame

You can use the URL for your report as the source for an HTML frame, which allows you to create layouts that combine multiple reports on a single page. For example, the code below divides a page into two vertical frames, both of which contain a report:

<frameset cols="*,*" frameborder="NO" border="0" framespacing="0">
  <frame src="http://www.lexisnexis.com/dossier/api/
  start.do?prod=CD&host=prspct&reportKey=snapshot_report&deliveryType=htm
  l&searchType=CDReportCompApi&compKey=c000001,c000002,c000003,c000004,c00000
  5,c000006,c000007,c000008,c000009,c000010,c000300,&cdName=INTERNATIONAL+BUSINESS
  +MACHINES+CORP&entityId=1036273&nnId=9D91DE51C5543CE60B6F23C03A58A4FBD522A7D
  FB76AD69FF8CD84D4F3722AF8E96377AE27F64579641EF2F94ABB314F82B6486C6B868513124550A2823
  D148E3605BA92EE098B0145AE6070441A1122916311B1C295871E&clientid=marc" name="
  leftFrame">
  <frame src="http://www.lexisnexis.com
  /dossier/api/start.do?prod=ID&host=prspct&reportKey=industry_snapshot_report
  &deliveryType=html&searchType=IDReportCompApi&compKey=i000100,&idNam
  e=Computer+programming+services&entityId=17371&clientid=marc" name="mai
  nFrame">
</frameset>

The image below shows the resulting page:

Frame example

Embed the Report in an iframe

HTML iframes create defined areas of content that can be placed inline with other page elements and arranged in a number of ways.

iframe Example 1

The code below creates an iframe containing a report and aligns it to the right side of the page:

<iframe align="right" width="300" height="400" src="http://www.lexisnexis.com/dossier/
  api/start.do?prod=CD&host=prspct&reportKey=financial_report&deliveryType=html&searchType=
  CDReportCompApi&compKey=c050100,&entityId=1036273&clientid=marc">
</iframe>

The image below shows how the resulting page would appear (the paragraphs represent content on your site, while the box to the right contains the Prospect Portfolio report hosted by LexisNexis):

iframe example 1

iframe Example 2

The code below creates 4 iframes containing reports and arranges them on 2 rows:

<iframe align="right" width="49%" height="285" src="http://www.lexisnexis.com/dossier/
  api/start.do?prod=CD&host=prspct&reportKey=snapshot_report&deliveryType=html&searchType=
  CDReportCompApi&compKey=c000300,&entityId=1036273&nnId=9D91DE51C5543CE60B6F23
  C03A58A4FBD522A7DFB76AD69FF8CD84D4F3722AF8E96377AE27F64579641EF2F94ABB314F82B6486C6B86851
  3124550A2823D148E3605BA92EE098B0145AE6070441A1122916311B1C295871E&clientid=marc">
</iframe>
<iframe width="49%" height="285" src="http://www.lexisnexis.com/dossier/
  api/start.do?prod=CD&host=prspct&reportKey=snapshot_report&deliveryType=html&searchType=
  CDReportCompApi&compKey=c000001,c000002,c000003,c000004,c000005,c000006,c000007,
  c000008,c000009,c000010,&entityId=1036273&nnId=9D91DE51C5543CE60B6F23C03A58
  A4FBD522A7DFB76AD69FF8CD84D4F3722AF8E96377AE27F64579641EF2F94ABB314F82B6486C6B86851
  3124550A2823D148E3605BA92EE098B0145AE6070441A1122916311B1C295871E&clientid=marc">
</iframe>
<iframe align="right" width="49%" height="285" src="http://www.lexisnexis.com/dossier/
  api/start.do?prod=CD&host=prspct&reportKey=financial_report&deliveryType=html&searchType=
  CDReportCompApi&compKey=c050200,&entityId=1036273&clientid=marc">
</iframe>
<iframe width="49%" height="285" src="http://www.lexisnexis.com/dossier/
  api/start.do?prod=CD&host=prspct&reportKey=financial_report&deliveryType=html&searchType=
  CDReportCompApi&compKey=c050100,&entityId=1036273&clientid=marc">
</iframe>

The image below shows the resulting page:

iframe example 2

Add a Link to the Report

Instead of embedding a report's content directly into your site, you can create a simple link to the report. For example, the code below creates links to 4 reports and specifies that they will open in a new window:

<ul>
  <li><a href="http://www.lexisnexis.com/dossier/api/start.do?prod=CD&host=
    prspct&reportKey=snapshot_report&deliveryType=html&searchType=CDReportCompApi&
    compKey=c000300,&entityId=1036273&nnId=9D91DE51C5543CE60B6F23C03A58A4FBD522
    A7DFB76AD69FF8CD84D4F3722AF8E96377AE27F64579641EF2F94ABB314F82B6486C6B868513124550A
    2823D148E3605BA92EE098B0145AE6070441A1122916311B1C295871E&clientid=marc" 
    target="_blank">IBM at a glace</a>
  </li>
  <li><a href="http://www.lexisnexis.com/dossier/api/start.do?prod=CD&host=
    prspct&reportKey=snapshot_report&deliveryType=html&searchType=CDReportCompApi&
    compKey=c000001,c000002,c000003,c000004,c000005,c000006,c000007,c000008,c000009,c0000
    10,&entityId=1036273&nnId=9D91DE51C5543CE60B6F23C03A58A4FBD522A7DFB76AD69FF8C
    D84D4F3722AF8E96377AE27F64579641EF2F94ABB314F82B6486C6B868513124550A2823D148E3605BA92
    EE098B0145AE6070441A1122916311B1C295871E&clientid=marc" target="_blank">
    Current news </a>
  </li>
  <li><a href="http://www.lexisnexis.com/dossier/api/start.do?prod=CD&host=
    prspct&reportKey=financial_report&deliveryType=html&searchType=
    CDReportCompApi&compKey=c050200,&entityId=1036273&clientid=marc" 
    target="_blank">Annual liabilities</a>
  </li>
  <li><a href="http://www.lexisnexis.com/dossier/api/start.do?prod=CD&host=
    prspct&reportKey=financial_report&deliveryType=html&searchType=
    CDReportCompApi&compKey=c050100,&entityId=1036273&clientid=marc" 
    target="_blank">Annual income</a>
  </li>
</ul>

The image below shows the resulting page:

Link example

Note: If you link to reports instead of embedding them directly, your usage won't be counted until users click a link to view a report.

 

Copyright © 2024  LexisNexis.  All rights reserved.