Registrar Web Services

<back to all web services

R_Product

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS,POST/R_Products
PUT,OPTIONS/R_Products/{Id}
DELETE,OPTIONS/R_Products/{Id}
R_Product Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
NamebodystringNo
DescriptionbodystringNo
ModelbodystringNo
PrefixbodystringNo
SeedValuebodyintNo
CreateDateTimebodyDateTimeNo
ModifiedDateTimebodyDateTime?No
NumberOfAssociatedUnitsbodyintNo
R_Product Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
NamebodystringNo
DescriptionbodystringNo
ModelbodystringNo
PrefixbodystringNo
SeedValuebodyintNo
CreateDateTimebodyDateTimeNo
ModifiedDateTimebodyDateTime?No
NumberOfAssociatedUnitsbodyintNo

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_Product HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	Description: String,
	Model: String,
	Prefix: String,
	SeedValue: 0,
	CreateDateTime: 0001-01-01,
	ModifiedDateTime: 0001-01-01,
	NumberOfAssociatedUnits: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	Description: String,
	Model: String,
	Prefix: String,
	SeedValue: 0,
	CreateDateTime: 0001-01-01,
	ModifiedDateTime: 0001-01-01,
	NumberOfAssociatedUnits: 0
}