Registrar Web Services

<back to all web services

R_Plans

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Plans
GET,OPTIONS/R_Plans/{Ids}
GET,OPTIONS/R_Plans/BundleId/{BundleId}
GET,OPTIONS/R_Plans/UnitId/{UnitId}
R_Plans Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
BundleIdpathlong?No
UnitIdpathstringNo
PlanBillingStructureIdsqueryList<long>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/R_Plans HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_Plans xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <BundleId>0</BundleId>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <PlanBillingStructureIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </PlanBillingStructureIds>
  <UnitId>String</UnitId>
</R_Plans>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_Plan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_Plan>
    <CurrencyTypeId>0</CurrencyTypeId>
    <Description>String</Description>
    <Id>0</Id>
    <Name>String</Name>
    <PlanBillingstructureId>0</PlanBillingstructureId>
    <PlanStatus>0</PlanStatus>
    <PriceDescription>String</PriceDescription>
  </R_Plan>
</ArrayOfR_Plan>