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

<R_Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
  <Description>String</Description>
  <Id>0</Id>
  <Model>String</Model>
  <ModifiedDateTime>0001-01-01T00:00:00</ModifiedDateTime>
  <Name>String</Name>
  <NumberOfAssociatedUnits>0</NumberOfAssociatedUnits>
  <Prefix>String</Prefix>
  <SeedValue>0</SeedValue>
</R_Product>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
  <Description>String</Description>
  <Id>0</Id>
  <Model>String</Model>
  <ModifiedDateTime>0001-01-01T00:00:00</ModifiedDateTime>
  <Name>String</Name>
  <NumberOfAssociatedUnits>0</NumberOfAssociatedUnits>
  <Prefix>String</Prefix>
  <SeedValue>0</SeedValue>
</R_Product>