Difference between revisions of "Clients"

From Advice Local Wiki
Jump to: navigation, search
(The client object)
(The client object)
Line 1: Line 1:
 
== Adding a Client ==
 
== Adding a Client ==
  
==== The client object ====
+
==== The Client Object ====
 
{| class="wikitable"
 
{| class="wikitable"
 
!colspan="6"|Attributes
 
!colspan="6"|Attributes
Line 190: Line 190:
 
|The custom5 field is for internal usage and replaces fkc5 in API Version 1.
 
|The custom5 field is for internal usage and replaces fkc5 in API Version 1.
 
|}
 
|}
 +
 +
==== Sample Request ====
  
 
== Updating a Client ==
 
== Updating a Client ==

Revision as of 16:54, 12 December 2017

Adding a Client

The Client Object

Attributes
id integer Unique identifier for the object.
name string (maxLength=128) required The busniess name.
owner string (maxLength=128) optional The business owner's name.
street string (maxLength=128) required The business street.
suite string (maxLength=32) optional The business suite.
hours The business hours.
city string (maxLength=128) required The business city.
state string (maxLength=64) required The business state.
zipcode string (maxLength=32) required The business zipcode.
phone string (maxLength=32) required The business phone number.
phoneAlt string (maxLength=32) optional The business additional phone number.
fax string (maxLength=32) optional The business fax number.
website string (maxLength=32) optional The business website.
email string (maxLength=32) optional The business email address.
facebook string (maxLength=32) optional The business facebook url.
twitter string (maxLength=32) optional The business twitter url.
linkedin string (maxLength=32) optional The business linkedIn url.
years string (maxLength=32) optional Number of years in business.
description string optional The business description.
payment string optional Payment Types Accepted by the business.
license string (maxLength=64) optional The business license.
keyword1 string (maxLength=64) optional The business keyword 1.
keyword2 string (maxLength=64) optional The business keyword 2.
keyword3 string (maxLength=64) optional The business keyword 3.
keyword4 string (maxLength=64) optional The business keyword 4.
keyword5 string (maxLength=64) optional The business keyword 5.
keyword1_location string (maxLength=128) optional The business keyword 1 location.
keyword2_location string (maxLength=128) optional The business keyword 2 location.
keyword3_location string (maxLength=128) optional The business keyword 3 location.
keyword4_location string (maxLength=128) optional The business keyword 4 location.
keyword5_location string (maxLength=128) optional The business keyword 5 location.
notes string optional Internal notes about the business.
custom1 string (maxLength=64) optional The custom1 field is for internal usage and replaces fkc1 in API Version 1.
custom2 string (maxLength=64) optional The custom2 field is for internal usage and replaces fkc2 in API Version 1.
custom3 string (maxLength=64) optional The custom3 field is for internal usage and replaces fkc3 in API Version 1.
custom4 string (maxLength=64) optional The custom4 field is for internal usage and replaces fkc4 in API Version 1.
custom5 string (maxLength=64) optional The custom5 field is for internal usage and replaces fkc5 in API Version 1.

Sample Request

Updating a Client