Get Plans (XML API)

Last modified on July 26, 2024

Use this operation to get all monitoring plans available in your AlertSite account.

Request URL

POST https://www.alertsite.com/restapi/devices/plans

Request Body

XML

<DevicePlans>
   <TxnHeader>
      <Request>
         <Login>_LOGIN_</Login>
         <SessionID>_SESSION_</SessionID>
         <ObjCust>_OBJCUST_</ObjCust>
         <ObjDevice>_OBJDEVICE_</ObjDevice>
      </Request>
   </TxnHeader>
   <Source>REST_Client</Source>
</DevicePlans>

Response Body

XML

<Response>
   <Status>0</Status>
   <Message>No errors.</Message>
   <SessionID>0847b739808e4656</SessionID>
   <ObjDevice></ObjDevice>
   <ObjCust>24567</ObjCust>
   <Custid>C24567</Custid>
   <Company>WidgetWorld</Company>
   <CurrPlan></CurrPlan>
   <CurrInterval></CurrInterval>
   <AvailablePlans>UBM - A/A:1:50,VMNODE-100:1:100</AvailablePlans>
   <DevicePlans>
      <Plan>
         <PlanCode>UBM - A/A</PlanCode>
         <PlanName>UBM-Annual Contract/Annual Bill</PlanName>
      </Plan>
      <Plan>
         <PlanCode>VMNODE-100</PlanCode>
         <PlanName>VM Node by AlertSite 100 Monitor</PlanName>
      </Plan>
   </DevicePlans>
</Response>

The relevant XML tags are:

AvailablePlans

List of available plans in the <PlanName>:<num_used>:<num_available> format. Multiple plans are separated with commas.

PlanCode

The alphanumeric ID, unique to each plan.

PlanName

The plan name.

See Also

List Monitors
Add Monitor
AlertSite XML API

Highlight search results