Registrar Web Services

<back to all web services

R_CreateRegistrationRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/R_CreateRegistrationRequest
OPTIONS/R_CreateRegistrationRequest
R_CreateRegistrationRequest Parameters:
NameParameterData TypeRequiredDescription
UnitIdbodystringNo
ProductIdbodylongNo
DeviceIdbodystringNo
DeviceSerialNumberbodystringNo
CellularProfileIdbodylongNo
PcbSerialbodystringNo
BoardFirmwareVersionbodystringNo
RadioFirmwareVersionbodystringNo
BrandIdbodylongNo
ElligibleBundleIdbodylong?No
ResellerIdbodylong?No
CustomFieldsbodyDictionary<string, string>No
ValidatebodyboolNo
IdbodylongNo
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller
R_CreateRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
RegistrationIdformlongNo

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

<R_CreateRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Registration">
  <Requester xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Interfaces">String</Requester>
  <BoardFirmwareVersion>String</BoardFirmwareVersion>
  <BrandId>0</BrandId>
  <CellularProfileId>0</CellularProfileId>
  <CustomFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomFields>
  <DeviceId>String</DeviceId>
  <DeviceSerialNumber>String</DeviceSerialNumber>
  <ElligibleBundleId>0</ElligibleBundleId>
  <Id>0</Id>
  <PcbSerial>String</PcbSerial>
  <ProductId>0</ProductId>
  <RadioFirmwareVersion>String</RadioFirmwareVersion>
  <ResellerId>0</ResellerId>
  <UnitId>String</UnitId>
  <Validate>false</Validate>
</R_CreateRegistrationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_CreateRegistrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Registration">
  <RegistrationId>0</RegistrationId>
</R_CreateRegistrationResponse>