POST api/ActivateDevice
Activates the device.
Request Information
URI Parameters
None.
Body Parameters
Model used to activate the mobile device.
ActivateDeviceModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountUrlName |
Account URL name or account number of practice (Required). |
string |
None. |
| DeviceName |
Name of the device to be activated (Required). |
string |
None. |
| Username |
Username of practice for activation of device (Required). |
string |
None. |
| Password |
Password of practice for activation of device (Required). |
string |
None. |
| DeviceKey |
Unique key for a registered device (Readonly). |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AccountUrlName": "sample string 1",
"DeviceName": "sample string 2",
"Username": "sample string 3",
"Password": "sample string 4",
"DeviceKey": "sample string 5"
}
application/xml, text/xml
Sample:
<ActivateDeviceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.ActivateDevices"> <AccountUrlName>sample string 1</AccountUrlName> <DeviceKey>sample string 5</DeviceKey> <DeviceName>sample string 2</DeviceName> <Password>sample string 4</Password> <Username>sample string 3</Username> </ActivateDeviceModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ActivateDeviceModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountUrlName |
Account URL name or account number of practice (Required). |
string |
None. |
| DeviceName |
Name of the device to be activated (Required). |
string |
None. |
| Username |
Username of practice for activation of device (Required). |
string |
None. |
| Password |
Password of practice for activation of device (Required). |
string |
None. |
| DeviceKey |
Unique key for a registered device (Readonly). |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"AccountUrlName": "sample string 1",
"DeviceName": "sample string 2",
"Username": "sample string 3",
"Password": "sample string 4",
"DeviceKey": "sample string 5"
}
application/xml, text/xml
Sample:
<ActivateDeviceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.ActivateDevices"> <AccountUrlName>sample string 1</AccountUrlName> <DeviceKey>sample string 5</DeviceKey> <DeviceName>sample string 2</DeviceName> <Password>sample string 4</Password> <Username>sample string 3</Username> </ActivateDeviceModel>