Beacon Web Services


PEAK 15 exposes its data and functionality via a series of Web Services called Beacon. This document is the official reference for that functionality. Beacon supports a RESTful interface, which means you can send an HTTP GET or POST to call exposed methods, and you'll get back an XML document in return.


The PEAK 15 data model is comprised of numerous entities. Entities contain attributes and entities are linked to each other by relationships. For example, the contact entity (i.e., table) includes a first name and last name attribute (i.e., column).  The only other required attribute to create a contact in PEAK 15 is contact type which is used to identify whether the contact is, for example, a prospect versus a client.

Simple "Hello World" Example

Copy and paste the following URL into your browser; substitute the token provided to your organization in place of the text "yourtokenhere" and hit ENTER. If you don't have a token, please contact support.



 

https://data2011.peak15systems.com/beacon2011/service.svc/insert/entity/contact
 ?token=yourtokenhere
 &firstname=Hello
 &lastname=World
&p15_contacttype_contactid=Prospect



The response you get back will the Globally Unique ID (aka GUID) for the new contact and will look like this:


E8064816-EB23-DE11-8408-005056B97005


Now use the following URL to get back all the attributes of that record like this:


https://data2011.peak15systems.com/beacon2011/service.svc/get/yourorgnamehere/entity/contact
?contactid=yourGUIDhere


Note: You can't use the same token we used to create the contact. To retrieve data from PEAK 15 you will authenticate using the user name and password provided to you. If you don't have this, please contact support.


The response you get back will be an XML representation of the contact.

Simple "Hello World" Example as an HTML form

The following simple HTML form will also create a contact after substituting in your token


<html>
 <head>    
       <title>Beacon Sample: Insert Contact</title>
 </head>
 <body>
 <formaction="https://data2011.peak15systems.com/beacon2011/service.svc/insert/entity/contact" method="post" enctype="application/x-www-form-urlencoded">    
            <inputtype="hidden" name="token" value="yourtokenhere"/>    
            First Name    
            <inputtype="text" name="firstname" maxlength="50" value="Hello"/>    
           Last Name    
           <inputtype="text" name="lastname" maxlength="50" value="World"/>    
           <inputtype="hidden" name="p15_contacttype_contactid" value="Prospect"/>            
           <inputtype="submit" value="Submit"/>
</body>
</html>