ScannerVision Web Server

PostConnections

The following routes are available for this service:
POST	/connections

**PostConnections** Parameters:
Name	Parameter	Data Type	Required
LoginCommand	body	string	No
LogoutCommand	body	string	No
Password	body	string	No
SaveCommand	body	string	No
UserName	body	string	No

**GetConnectionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Connections	form	IEnumerable<IConnectorConnection>	No
IsAuthenticated	form	bool	No

**IConnectorConnection** Parameters:
Name	Parameter	Data Type	Required
ConnectorId	form	Guid	No
Description	form	string	No
Id	form	string	No
MaxConnections	form	int	No
Name	form	string	No
Permissions	form	ReadOnlyCollection<IConnectionPermission>	No
PropertyDescriptions	form	ReadOnlyCollection<IConnectionPropertyDescription>	No
SetupUser	form	IUser	No

**IConnectionPermission** Parameters:
Name	Parameter	Data Type	Required
Allow	form	bool	No
Connection	form	IConnectorConnection	No
Type	form	PermissionType	No

**PermissionType** Enum:
Group
User

**IConnectionPropertyDescription** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
Name	form	string	No
PropertyId	form	Guid	No
PropertyType	form	PropertyType	No

**PropertyType** Enum:
Name	Value
Binary	1
Boolean	2
ConnectionString	3
Credential	4
Integer	5
Picklist	6
String	7
OAuth2	8
Certificate	9

**IUser** Parameters:
Name	Parameter	Data Type	Required
Groups	form	ReadOnlyCollection<IUserGroup>	No
EmailAddress	form	string	No
HasPassword	form	bool	No
HomeFolder	form	string	No
Password	form	string	No
SbcUser	form	bool?	No

**IUserGroup** Parameters:
Name	Parameter	Data Type	Required	Description
Users	form	ReadOnlyCollection<IUser>	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /connections HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LoginCommand":"String","LogoutCommand":"String","Password":"String","SaveCommand":"String","UserName":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsAuthenticated":false}