GET api/Register?APIKey={APIKey}&MACaddress={MACaddress}&ModelNumber={ModelNumber}&OwnerEmail={OwnerEmail}&LocationName={LocationName}&LocationTimeZone={LocationTimeZone}&ControllerName={ControllerName}

This will return the ControllerID and Password for a controller that has never been registered on the IPS Website. The system will try to find an existing account with the Email provided. If not found, a new account is created. If found the controller is added to the account. The system will then try to match the Location Name and add the controller to the location. This will enable the controller on the IPS monitoring website and allow the owner to login directly to our website. If you do not want this to happen, you need to specify an email for your company to act as the owner.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

The API key provided

string

Required

MACaddress

The MACaddress of the controller. Must be in the format of XX:XX:XX:XX:XX:XX

string

Required

ModelNumber

The Integer that represents the Model Number. 1=M820, 2=M920, 3=M920-CA

integer

Required

OwnerEmail

The email address for the desired owner of the controller

string

Required

LocationName

A Location name for identification on the IPS Controller Website

string

Required

LocationTimeZone

The Integer that represents the TimeZone. 1=Eastern, 2=Central, 3=Mountain, 4=Pacific, 5=Alaska, 6=Hawaii

integer

Required

ControllerName

A Controller name for identification on the IPS Controller Website

string

Required

Body Parameters

None.

Response Information

Resource Description

The system returns a JSON object that contains the ControllerID and the ControllerPassword.

ControllerRegistration
NameDescriptionTypeAdditional information
ControllerID

string

None.

ControllerPassword

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ControllerID": "sample string 1",
  "ControllerPassword": "sample string 2"
}

application/xml, text/xml

Sample:
<RegisterController.ControllerRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIreg.Controllers">
  <ControllerID>sample string 1</ControllerID>
  <ControllerPassword>sample string 2</ControllerPassword>
</RegisterController.ControllerRegistration>