Registrar Web Services

<back to all 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:
NameParameterData TypeRequiredDescription
NamebodystringNo
DescriptionbodystringNo
PriceDescriptionbodystringNo
CurrencyTypeIdbodylongNo
PlanStatusbodylongNo
BillingStructureIdbodylongNo
PriceListbodyList<R_Price>No
ValidatebodyboolNo
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller
R_Price Parameters:
NameParameterData TypeRequiredDescription
PlanIdformlong?No
PromoIdformlong?No
DescriptionformstringNo
PriceTypeIdformlongNo
ValueformdecimalNo
IntervalformintNo
IntervalTypeIdformlongNo
CurrencyTypeIdformlongNo
IncludeInRegularBillformboolNo
IncludeInTrialBillformboolNo
IdformlongNo
R_CreatePlanResponse Parameters:
NameParameterData TypeRequiredDescription
PlanIdformlongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/R_CreatePlanRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Description: String,
	PriceDescription: String,
	CurrencyTypeId: 0,
	PlanStatus: 0,
	BillingStructureId: 0,
	PriceList: 
	[
		{
			PlanId: 0,
			PromoId: 0,
			Description: String,
			PriceTypeId: 0,
			Value: 0,
			Interval: 0,
			IntervalTypeId: 0,
			CurrencyTypeId: 0,
			IncludeInRegularBill: False,
			IncludeInTrialBill: False,
			Id: 0
		}
	],
	Validate: False,
	Requester: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PlanId: 0
}