POST api/Devices
Request Information
URI Parameters
None.
Body Parameters
Device| Name | Description | Type | Additional information |
|---|---|---|---|
| phoneNumber | string |
Required |
|
| firstName | string |
Required |
|
| lastName | string |
Required |
|
| emailAddress | string |
Required |
|
| deviceId | string |
None. |
|
| deviceName | string |
Required |
|
| deviceModel | string |
Required |
|
| deviceMacAddress | string |
None. |
|
| deviceType | integer |
Required |
|
| azureRegistrationToken | string |
None. |
|
| azureRegistrationId | string |
None. |
|
| crmAccountId | string |
None. |
|
| verified | boolean |
None. |
|
| suburbId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"phoneNumber": "sample string 1",
"firstName": "sample string 2",
"lastName": "sample string 3",
"emailAddress": "sample string 4",
"deviceId": "sample string 5",
"deviceName": "sample string 6",
"deviceModel": "sample string 7",
"deviceMacAddress": "sample string 8",
"deviceType": 9,
"azureRegistrationToken": "sample string 10",
"azureRegistrationId": "sample string 11",
"crmAccountId": "sample string 12",
"verified": true,
"suburbId": "2fcb2c4a-0f27-4bdb-a392-b5e49cf5864d"
}
application/xml, text/xml
Sample:
<Device xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConnectAPI.Models"> <azureRegistrationId>sample string 11</azureRegistrationId> <azureRegistrationToken>sample string 10</azureRegistrationToken> <crmAccountId>sample string 12</crmAccountId> <deviceId>sample string 5</deviceId> <deviceMacAddress>sample string 8</deviceMacAddress> <deviceModel>sample string 7</deviceModel> <deviceName>sample string 6</deviceName> <deviceType>9</deviceType> <emailAddress>sample string 4</emailAddress> <firstName>sample string 2</firstName> <lastName>sample string 3</lastName> <phoneNumber>sample string 1</phoneNumber> <suburbId>2fcb2c4a-0f27-4bdb-a392-b5e49cf5864d</suburbId> <verified>true</verified> </Device>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Device| Name | Description | Type | Additional information |
|---|---|---|---|
| phoneNumber | string |
Required |
|
| firstName | string |
Required |
|
| lastName | string |
Required |
|
| emailAddress | string |
Required |
|
| deviceId | string |
None. |
|
| deviceName | string |
Required |
|
| deviceModel | string |
Required |
|
| deviceMacAddress | string |
None. |
|
| deviceType | integer |
Required |
|
| azureRegistrationToken | string |
None. |
|
| azureRegistrationId | string |
None. |
|
| crmAccountId | string |
None. |
|
| verified | boolean |
None. |
|
| suburbId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"phoneNumber": "sample string 1",
"firstName": "sample string 2",
"lastName": "sample string 3",
"emailAddress": "sample string 4",
"deviceId": "sample string 5",
"deviceName": "sample string 6",
"deviceModel": "sample string 7",
"deviceMacAddress": "sample string 8",
"deviceType": 9,
"azureRegistrationToken": "sample string 10",
"azureRegistrationId": "sample string 11",
"crmAccountId": "sample string 12",
"verified": true,
"suburbId": "139198ab-d504-4fa1-8646-408cb91209b1"
}
application/xml, text/xml
Sample:
<Device xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConnectAPI.Models"> <azureRegistrationId>sample string 11</azureRegistrationId> <azureRegistrationToken>sample string 10</azureRegistrationToken> <crmAccountId>sample string 12</crmAccountId> <deviceId>sample string 5</deviceId> <deviceMacAddress>sample string 8</deviceMacAddress> <deviceModel>sample string 7</deviceModel> <deviceName>sample string 6</deviceName> <deviceType>9</deviceType> <emailAddress>sample string 4</emailAddress> <firstName>sample string 2</firstName> <lastName>sample string 3</lastName> <phoneNumber>sample string 1</phoneNumber> <suburbId>139198ab-d504-4fa1-8646-408cb91209b1</suburbId> <verified>true</verified> </Device>