Registrar Web Services

R_CreatePlanRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/R_CreatePlanRequest
OPTIONS	/R_CreatePlanRequest

**R_CreatePlanRequest** Parameters:
Name	Parameter	Data Type	Required
Name	body	string	No
Description	body	string	No
PriceDescription	body	string	No
CurrencyTypeId	body	long	No
PlanStatus	body	long	No
BillingStructureId	body	long	No
PriceList	body	List<R_Price>	No
Validate	body	bool	No

**BaseAdminRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Requester	form	string	No	Identity of the caller

**R_Price** Parameters:
Name	Parameter	Data Type	Required
PlanId	form	long?	No
PromoId	form	long?	No
Description	form	string	No
PriceTypeId	form	long	No
Value	form	decimal	No
Interval	form	int	No
IntervalTypeId	form	long	No
CurrencyTypeId	form	long	No
IncludeInRegularBill	form	bool	No
IncludeInTrialBill	form	bool	No
Id	form	long	No

**R_CreatePlanResponse** Parameters:
Name	Parameter	Data Type	Required	Description
PlanId	form	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_CreatePlanRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_CreatePlanRequest 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>
  <BillingStructureId>0</BillingStructureId>
  <CurrencyTypeId>0</CurrencyTypeId>
  <Description>String</Description>
  <Name>String</Name>
  <PlanStatus>0</PlanStatus>
  <PriceDescription>String</PriceDescription>
  <PriceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:R_Price>
      <d2p1:CurrencyTypeId>0</d2p1:CurrencyTypeId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IncludeInRegularBill>false</d2p1:IncludeInRegularBill>
      <d2p1:IncludeInTrialBill>false</d2p1:IncludeInTrialBill>
      <d2p1:Interval>0</d2p1:Interval>
      <d2p1:IntervalTypeId>0</d2p1:IntervalTypeId>
      <d2p1:PlanId>0</d2p1:PlanId>
      <d2p1:PriceTypeId>0</d2p1:PriceTypeId>
      <d2p1:PromoId>0</d2p1:PromoId>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:R_Price>
  </PriceList>
  <Validate>false</Validate>
</R_CreatePlanRequest>

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

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