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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/GetFloorPlan HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<GetFloorPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <PlanID>0</PlanID>
  <ShowConnector>0</ShowConnector>
  <ShowZone>0</ShowZone>
  <SiteURL>String</SiteURL>
  <UserID>String</UserID>
</GetFloorPlan>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetFloorPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <PlanResult>
    <connections>
      <Connection>
        <background>String</background>
        <content>
          <align>String</align>
          <color>String</color>
          <fontSize>String</fontSize>
          <text>String</text>
        </content>
        <cursor>String</cursor>
        <enable>false</enable>
        <endCap>String</endCap>
        <from>
          <connector>String</connector>
          <shapeId>String</shapeId>
        </from>
        <hover>
          <stroke />
        </hover>
        <id>String</id>
        <points xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
        </points>
        <select>
          <handles>
            <background>String</background>
            <height>0</height>
            <stroke>
              <color>String</color>
            </stroke>
            <width>0</width>
          </handles>
        </select>
        <selectable>false</selectable>
        <serializable>false</serializable>
        <startCap>String</startCap>
        <stroke>
          <color>String</color>
          <width>0</width>
        </stroke>
        <to>
          <connector>String</connector>
          <shapeId>String</shapeId>
        </to>
      </Connection>
    </connections>
    <shapes>
      <Shape>
        <background>String</background>
        <connectorDefaults>
          <background>String</background>
          <hover>
            <background>String</background>
            <stroke>
              <color>String</color>
            </stroke>
          </hover>
          <stroke>
            <color>String</color>
          </stroke>
        </connectorDefaults>
        <connectors>
          <Connector>
            <description>String</description>
            <name>String</name>
          </Connector>
        </connectors>
        <content>
          <align>String</align>
          <color>String</color>
          <fontSize>String</fontSize>
          <text>String</text>
        </content>
        <cursor>String</cursor>
        <enable>false</enable>
        <fill>
          <color>String</color>
          <opacity>0</opacity>
        </fill>
        <height>0</height>
        <hover>
          <opacity>0</opacity>
        </hover>
        <id>String</id>
        <minHeight>0</minHeight>
        <minWidth>0</minWidth>
        <path>String</path>
        <rotation>
          <angle>0</angle>
        </rotation>
        <selectable>false</selectable>
        <serializable>false</serializable>
        <source>String</source>
        <stroke>
          <color>String</color>
          <width>0</width>
        </stroke>
        <type>String</type>
        <undoable>false</undoable>
        <visual />
        <width>0</width>
        <x>0</x>
        <y>0</y>
      </Shape>
    </shapes>
  </PlanResult>
</GetFloorPlanResponse>