Added by admin, last edited by admin on Jan 18, 2010  (view change)

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

BookingBug REST API: address

Purpose

Used for creating and editing addresses within BookingBug. An address is used for a number of purposes. Admin users can have addresses, resources and have addresses, events or classes can have addresses, and the company itself can have a default address.

By default, for a small business, the user and a the company share a common address, further addresses can be created as needs

URL

http://[site].bookingbug.com/api/address.format

Formats

json, xml

Authentication

Requies business API access

Parameters
param type description required? default
company_id integer The company this address applies to. Required when using the function directly, but not as a data block as part of resource or company call Yes  
address1 string(50) Line 1 of the address Yes  
address2 string(50)
Line 2 of the address No  
address3 string(50) Line 3 - the Town Yes  
address4
string(50)
Line 4 - the County / State No  
postcode string(50)
A Postcode or Zipcode No  
country string(50)
The Country No defaults to the locale
email string(50) a default email address No  
mobile string(50) a mobile phone number for the address, of one other following formats:
+[code] [number]   e.g. +44 12345678    (the space is important)
+[number] e.g. 012345678 (the default code will be added)
   
phone string(50)
a landline phone - same format as above    
name string(50) an optional name for the address