POST api/communicationserverapi/add?siteId={siteId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteId | globally unique identifier |
None. |
Body Parameters
CommunicationServerViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| active | boolean |
Required |
|
| db_login | string |
Required |
|
| db_name | string |
Required |
|
| db_password | string |
Required |
|
| db_source | string |
Required |
|
| description | string |
Required |
|
| id | globally unique identifier |
None. |
|
| local_ip | string |
Required |
|
| local_name | string |
None. |
|
| mac_address | string |
Required String length: inclusive between 0 and 30 |
|
| site_id | globally unique identifier |
None. |
|
| iscleanroom | boolean |
None. |
|
| isdistribution | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"active": true,
"db_login": "sample string 2",
"db_name": "sample string 3",
"db_password": "sample string 4",
"db_source": "sample string 5",
"description": "sample string 6",
"id": "676775fd-41a1-4ed3-9ba9-3d2deb9fa048",
"local_ip": "sample string 8",
"local_name": "sample string 9",
"mac_address": "sample string 10",
"site_id": "05f5a412-d168-4e6d-9af2-c4d377844abe",
"iscleanroom": true,
"isdistribution": true
}
application/xml, text/xml
Sample:
<communication_server xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel"> <active>true</active> <db_login>sample string 2</db_login> <db_name>sample string 3</db_name> <db_password>sample string 4</db_password> <db_source>sample string 5</db_source> <description>sample string 6</description> <id>676775fd-41a1-4ed3-9ba9-3d2deb9fa048</id> <iscleanroom>true</iscleanroom> <isdistribution>true</isdistribution> <local_ip>sample string 8</local_ip> <local_name>sample string 9</local_name> <mac_address>sample string 10</mac_address> <site_id>05f5a412-d168-4e6d-9af2-c4d377844abe</site_id> </communication_server>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"39e23b0c-4e99-4b01-b199-f85266da5bc7"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">39e23b0c-4e99-4b01-b199-f85266da5bc7</guid>