HostedSuite

ArchiveClientRequest

Archives a client

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

**ArchiveClientRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	body	string	No	The ID of the client. Use this or the Name parameter
ClientName	body	string	No	The name of the client. Use this or the Id parameter

**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

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/archive HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientId: String,
	ClientName: String,
	CustomerName: String,
	UserName: String,
	Password: String
}

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

{
	
}

**AttendeeInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
EmailAddress	form	string	No

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

**PaymentStatus** Enum:
None
NotPaid
PartiallyPaid
Overdue
Paid
Included
Cancelled
NoCharge
Confirmed
BillOther
Other

**ReservationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
EntityStatus	form	string	No
CenterId	form	string	No
CenterName	form	string	No
CenterAddress	form	string	No
MeetingRoomId	form	string	No
MeetingRoomName	form	string	No
StartTime	form	string	No
EndTime	form	string	No
Subject	form	string	No
Status	form	string	No
Notes	form	string	No
PaymentStatus	form	string	No
ClientId	form	string	No
ClientName	form	string	No
IsRecurring	form	bool	No
OriginalDate	form	string	No
DateLastModified	form	string	No
LastModifiedBy	form	string	No
Attendees	form	List<AttendeeInfo>	No
NumAttendees	form	int	No
Organizer	form	AttendeeInfo	No
CustomFields	form	List<CustomFieldInfo>	No

HTTP + JSV

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

POST /api/scheduling/update-payment-status HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ReservationId: String,
	OriginalDate: String,
	PaymentStatus: None,
	CustomerName: String,
	UserName: String,
	Password: String
}

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

{
	Id: String,
	EntityStatus: String,
	CenterId: String,
	CenterName: String,
	CenterAddress: String,
	MeetingRoomId: String,
	MeetingRoomName: String,
	StartTime: String,
	EndTime: String,
	Subject: String,
	Status: String,
	Notes: String,
	PaymentStatus: String,
	ClientId: String,
	ClientName: String,
	IsRecurring: False,
	OriginalDate: String,
	DateLastModified: String,
	LastModifiedBy: String,
	Attendees: 
	[
		{
			Name: String,
			EmailAddress: String
		}
	],
	NumAttendees: 0,
	Organizer: 
	{
		Name: String,
		EmailAddress: String
	},
	CustomFields: 
	[
		{
			Name: String,
			Value: String
		}
	]
}