Registrar Web Services

<back to all web services

R_Products

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS, GET/R_Products
OPTIONS, GET/R_Products/{Ids}
R_Products Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
IncludeRegistrationCountqueryboolNo

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

<R_Products xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <IncludeRegistrationCount>false</IncludeRegistrationCount>
</R_Products>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_Product>
    <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>
</ArrayOfR_Product>