Registrar Web Services

<back to all web services

R_PurgePlanRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/R_PurgePlanRequest
OPTIONS/R_PurgePlanRequest
R_PurgePlanRequest Parameters:
NameParameterData TypeRequiredDescription
PlanIdbodylongNo
ValidatebodyboolNo
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller

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_PurgePlanRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_PurgePlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Management.Plan">
  <Requester xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Interfaces">String</Requester>
  <PlanId>0</PlanId>
  <Validate>false</Validate>
</R_PurgePlanRequest>

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

<R_PurgePlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Management.Plan" />