Registrar Web Services

<back to all web services

R_HardwareProfiles

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS, GET/R_HardwareProfiles
OPTIONS, GET/R_HardwareProfiles/{Ids}
OPTIONS, GET/R_HardwareProfiles/CPIds/{CellularProfileIds}
R_HardwareProfiles Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
CellularProfileIdspathList<long>No
ProductIdsqueryList<long>No
FrmVrquerystringNo
RadioFrmVrquerystringNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No
OnlyRecordsCountqueryboolNo
SortByquerystringNo
DescOrderqueryboolNo
NamequerystringNo
DescriptionquerystringNo

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

HTTP + CSV

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

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

{"Ids":[0],"CellularProfileIds":[0],"ProductIds":[0],"FrmVr":"String","RadioFrmVr":"String","StartIndex":0,"NumberOfRecords":0,"OnlyRecordsCount":false,"SortBy":"String","DescOrder":false,"Name":"String","Description":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"Id":0,"CellularProfileId":0,"FirmwareVersion":"String","RadioFirmwareVersion":"String","ProductId":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","UpdatedDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0,"Name":"String","Description":"String"}]