HostedSuite

NewClientRequest

Saves a new client

The following routes are available for this service:
POST	/api/clients/save

**NewClientRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Name	body	string	Yes	The company name
CenterId	body	string	No	The ID of the center to associate with this client. Leave null to use the first center in the database.
ScreenPops	body	List<string>	No	The screen pops to associate with this client.
ScreenPopObjects	body	List<ScreenPopInfo>	No	The screen pops to associate with this client. Use this field to provide more info than the standard ScreenPops member.
Greeting	body	string	No	The greeting for the client.
CallInstructions	body	string	No	The client's call instructions
PopupInformation	body	string	No	The client's popup info
Information	body	string	No	Information about this client.
ContractId	body	string	No	The ID of the Contract to assign with this client.
Location	body	string	No	The Location of this Client, e.g. "Suite 100"
ThirdPartyAccountId	body	string	No	Third party ID for this client
CustomFields	body	List<CustomFieldInfo>	No	Any custom fields for the client
Links	body	List<HyperlinkInfo>	No	This client's links
CategoryIds	body	List<string>	No	The IDs of the categories to associate this client with. Leave NULL to not change
CallAllowanceType	body	CallAllowanceType?	No	The type of call allowance assigned to this client. (NotBillable, NumberOfMinutes, NumberOfCalls)
CallAllowanceAmount	body	double?	No	The amount of call allowance this client has.
Address	body	AddressInfo	No	The client's address
FaxNumber	body	string	No	The client's fax number
WebSiteUrl	body	string	No	The client's web site URL
InformationCSV	body	string	No	The client's information in CSV format
IndustryId	body	string	No	The ID of the industry to associate this client with
CategoryId	body	string	No	The ID of the category to associate with this client

**RequestBase<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	form	string	Yes	The HostedSuite Customer Name
UserName	form	string	Yes	The HostedSuite User Name. Data visibility and security is based on this user's permissions.
Password	form	string	Yes	The HostedSuite User's Password

**ClientInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
DateLastModified	form	string	No
Name	form	string	No
CenterId	form	string	No
CenterName	form	string	No
ScreenPops	form	List<string>	No
Greeting	form	string	No
CallInstructions	form	string	No
PopupInformation	form	string	No
Information	form	string	No
FaxNumber	form	string	No
CustomFields	form	List<CustomFieldInfo>	No
Address	form	AddressInfo	No
ThirdPartyAccountId	form	string	No
CallAllowanceType	form	CallAllowanceType	No
CallAllowanceAmount	form	double	No
Links	form	List<HyperlinkInfo>	No
IndustryId	form	string	No
IndustryName	form	string	No
Categories	form	IList<CategoryInfo>	No
Location	form	string	No

**CustomFieldInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**AddressInfo** Parameters:
Name	Parameter	Data Type	Required
Street1	form	string	No
Street2	form	string	No
City	form	string	No
State	form	string	No
PostalCode	form	string	No
Country	form	string	No

**CallAllowanceType** Enum:
NotBillable
NumberOfMinutes
NumberOfCalls

**HyperlinkInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Url	form	string	No

**CategoryInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**ScreenPopInfo** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	No
ContactId	form	string	No
CallBoxColor	form	string	No
GreetingColor	form	string	No
FormToOpenId	form	string	No
IconType	form	IconTypes	No

**IconTypes** Enum:
None
User
GrayUser
Table
Star
Smiley
Envelope

**ClientInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
DateLastModified	form	string	No
Name	form	string	No
CenterId	form	string	No
CenterName	form	string	No
ScreenPops	form	List<string>	No
Greeting	form	string	No
CallInstructions	form	string	No
PopupInformation	form	string	No
Information	form	string	No
FaxNumber	form	string	No
CustomFields	form	List<CustomFieldInfo>	No
Address	form	AddressInfo	No
ThirdPartyAccountId	form	string	No
CallAllowanceType	form	CallAllowanceType	No
CallAllowanceAmount	form	double	No
Links	form	List<HyperlinkInfo>	No
IndustryId	form	string	No
IndustryName	form	string	No
Categories	form	IList<CategoryInfo>	No
Location	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/clients/save HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	CenterId: String,
	ScreenPops: 
	[
		String
	],
	ScreenPopObjects: 
	[
		{
			Number: String,
			ContactId: String,
			CallBoxColor: String,
			GreetingColor: String,
			FormToOpenId: String,
			IconType: None
		}
	],
	Greeting: String,
	CallInstructions: String,
	PopupInformation: String,
	Information: String,
	ContractId: String,
	Location: String,
	ThirdPartyAccountId: String,
	CustomFields: 
	[
		{
			Name: String,
			Value: String
		}
	],
	Links: 
	[
		{
			Id: String,
			Name: String,
			Url: String
		}
	],
	CategoryIds: 
	[
		String
	],
	CallAllowanceType: NotBillable,
	CallAllowanceAmount: 0,
	Address: 
	{
		Street1: String,
		Street2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String
	},
	FaxNumber: String,
	WebSiteUrl: String,
	InformationCSV: String,
	IndustryId: String,
	CategoryId: String,
	CustomerName: String,
	UserName: String,
	Password: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	DateLastModified: String,
	Name: String,
	CenterId: String,
	CenterName: String,
	ScreenPops: 
	[
		String
	],
	Greeting: String,
	CallInstructions: String,
	PopupInformation: String,
	Information: String,
	FaxNumber: String,
	CustomFields: 
	[
		{
			Name: String,
			Value: String
		}
	],
	Address: 
	{
		Street1: String,
		Street2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String
	},
	ThirdPartyAccountId: String,
	CallAllowanceType: NotBillable,
	CallAllowanceAmount: 0,
	Links: 
	[
		{
			Id: String,
			Name: String,
			Url: String
		}
	],
	IndustryId: String,
	IndustryName: String,
	Location: String
}