...
| Info |
|---|
This introduction is written based on experience drawn from a lot of custom integrations. It is aimed at consultants implementing an integration for a BRP-customer. An API-integration with BRP is a very complex task, not in a technical sense but the domain knowledge required for a successful end result is substantial. As a consultant you will have to spend a lot of time in cooperation with your client's BRP-users to gain a full understanding of the system and how it is used. Every integration project must have these three roles defined before even starting: BRP will debit the hours spent on the project. There is a monthly fee for write access to the API (POST, PUT, DELETE). Read access is free. |
Support tickets
Be as specific as you can possibly be, for example:
...
| Code Block | ||
|---|---|---|
| ||
<errors>
<error>
<code>1001</code>
<message>Invalid parameter, firstname</message>
<debuginfo>field=firstname</debuginfo>
</error>
</errors>
|
Format
Data type | Format | Example | Comments |
|---|---|---|---|
Date | yyyy-MM-DD | 2012-12-24 | GMT+1 (Stockholm) including adjustments required for summer and winter time |
Time | HH:mm | 14:54 | GMT+1 (Stockholm) including adjustments required for summer and winter time |
Timestamp | nnnnnnnnnnnnn | 1298023236 | Unix Epoch, Number of seconds since 1/1 1970, 00:00:00 GMT |
Boolean | true/false | true |
ID-list | n,n,n.... | 1,2,45 | List containing object id |
String |
Spinningsal | Text string UTF-8 in desired length. Characters are escaped in accordance with either XML or JSON standards. | ||
Number | nnnnnnnnn | 124234 | Integers are always specified without thousands separators or 10 powers |
Decimal | nnnn.nnn | 34.45 | There are no limits for the number of decimals that may be used. No thousands separators or 10 powers. If the number of decimals is 0 no decimal divider will be sent. |
ID | nnnn | 43 | Integer that is an object ID |
Product type | groupActivity/ subscription/ package/ article/ service/ event/ stockProduct/ valueCard/ entry | groupActivity | Text strings that represent product groups |
Sex | male/female | female | Text strings denoting sex |
Valid e-mail address | |||
Personal ID number |
850101-123X | Valid Swedish, Norwegian or Finnish personal ID number, depending on the facility. For persons connected to a Swedish facility a Swedish personal ID number must be used. | |
Telephone number |
013-342 00 20 | Valid telephone number |
Miscellaneous
When currency is used it is specified in Swedish öre or Euro cents. For example: SEK 34,99 is formatted as 3499.
...
NOTE: Send parameters in either the request string OR body, not both, when using PUT. Using both will result in the parameters in the body being ignored.
| Code Block |
|---|
https://api.brpsystems.se/brpgog/api/ver2/baz |
...
| Code Block |
|---|
APIURL/restobjects.xml?apikey=123 APIURL/restobjects.json?apikey=123 |
Definitions
Word | Definition | Comments |
|---|---|---|
activitybooking | Class booking | Class booking and waiting list |
purchase | Purchase | Purchase of services, events, goods, subscriptions, value cards and deals |
person | User/booker |
resource | Resource | Rooms, instructors, staff, equipment etc. |
activity | Group activity/class |
event | Event | Events such as speaches, courses |
order | Order | Completed order, either paid or confirmed |
bokning | Booking | Based on type of product: service, goods, subscription, valuecard and deal |
receipt | Receipt |
item | Order row or receipt row |
timeslotsuggestions | Suggested time for service booking |