HostedSuite

ListCompletedFormsRequest

Retrieves completed forms for the specified client and date range

The following routes are available for this service:
POST	/api/forms/completed

**ListCompletedFormsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
StartDate	body	DateTime	No	The start of the date range to list forms for
EndDate	body	DateTime	No	The end of the date range to list forms for
ClientId	body	string	No	The ID of the client whose forms you want to list
SpecificFormId	body	string	No	The ID of the specific form you want to get. Using this field will return a single result

**PagedRequestBase<TITemType>** Parameters:
Name	Parameter	Data Type	Required
Page	form	int	No
ItemsPerPage	form	int	No
DisableStats	form	bool	No
SortField	form	string	No
SortDir	form	SortDir	No

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

**SortDir** Enum:
Asc
Desc

**CompletedFormInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
ClientId	form	string	No
ClientName	form	string	No
ContactId	form	string	No
ContactName	form	string	No
EmailSubject	form	string	No
CallerNumber	form	string	No
DateCompleted	form	string	No
LocalClientTime	form	string	No
Fields	form	List<CompletedFormFieldInfo>	No
HasBeenRead	form	bool	No
CallRecordId	form	string	No
CreatedByName	form	string	No

**CompletedFormFieldInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Values	form	List<string>	No

**PagedResponseBase<TItemType>** Parameters:
Name	Parameter	Data Type	Required
Items	form	List<TItemType>	No
Page	form	int	No
TotalCount	form	long	No
TotalPages	form	int	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/forms/completed HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	ClientId: String,
	SpecificFormId: String,
	Page: 0,
	ItemsPerPage: 0,
	DisableStats: False,
	SortField: String,
	SortDir: Asc,
	CustomerName: String,
	UserName: String,
	Password: String
}

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

{
	Items: 
	[
		{
			Id: String,
			Name: String,
			ClientId: String,
			ClientName: String,
			ContactId: String,
			ContactName: String,
			EmailSubject: String,
			CallerNumber: String,
			DateCompleted: String,
			LocalClientTime: String,
			Fields: 
			[
				{
					Name: String,
					Values: 
					[
						String
					]
				}
			],
			HasBeenRead: False,
			CallRecordId: String,
			CreatedByName: String
		}
	],
	Page: 0,
	TotalCount: 0,
	TotalPages: 0
}