eQuipAPI

<back to all web services

GetFloorPlan

The following routes are available for this service:
All Verbs/GetFloorPlan/{UserID}/{PlanID}/{ShowZone}/{ShowConnector}/{SiteURL}
GetFloorPlan Parameters:
NameParameterData TypeRequiredDescription
UserIDpathstringNo
PlanIDpathintNo
ShowZonepathshortNo
ShowConnectorpathshortNo
SiteURLpathstringNo
GetFloorPlanResponse Parameters:
NameParameterData TypeRequiredDescription
PlanResultbodyPlanResultNo
PlanResult Parameters:
NameParameterData TypeRequiredDescription
shapesbodyList<Shape>No
connectionsbodyList<Connection>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 /jsv/reply/GetFloorPlan HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	PlanID: 0,
	ShowZone: 0,
	ShowConnector: 0,
	SiteURL: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PlanResult: 
	{
		shapes: 
		[
			{
				id: String,
				background: String,
				source: String,
				hover: 
				{
					opacity: 0
				},
				cursor: String,
				fill: 
				{
					color: String,
					opacity: 0
				},
				content: 
				{
					align: String,
					text: String,
					color: String,
					fontSize: String
				},
				selectable: False,
				serializable: False,
				enable: False,
				type: String,
				path: String,
				visual: {},
				x: 0,
				y: 0,
				minWidth: 0,
				minHeight: 0,
				width: 0,
				height: 0,
				connectors: 
				[
					{
						name: String,
						description: String
					}
				],
				rotation: 
				{
					angle: 0
				},
				stroke: 
				{
					width: 0,
					color: String
				},
				connectorDefaults: 
				{
					background: String,
					stroke: 
					{
						color: String
					},
					hover: 
					{
						background: String,
						stroke: 
						{
							color: String
						}
					}
				},
				undoable: False
			}
		],
		connections: 
		[
			{
				from: 
				{
					shapeId: String,
					connector: String
				},
				to: 
				{
					shapeId: String,
					connector: String
				},
				id: String,
				background: String,
				hover: 
				{
					stroke: {}
				},
				cursor: String,
				content: 
				{
					align: String,
					text: String,
					color: String,
					fontSize: String
				},
				selectable: False,
				serializable: False,
				enable: False,
				startCap: String,
				endCap: String,
				points: 
				[
					{
						
					}
				],
				stroke: 
				{
					width: 0,
					color: String
				},
				select: 
				{
					handles: 
					{
						width: 0,
						height: 0,
						background: String,
						stroke: 
						{
							color: String
						}
					}
				}
			}
		]
	}
}