POST api/communicationserverapi/addsync?siteId={siteId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		globally unique identifier	Required

Body Parameters

CommunicationServerSyncViewModel

Name	Type	Additional information
last_update	date	Required
last_update_user	globally unique identifier	Required
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:

{
  "last_update": "2026-06-09T21:56:01.4677804+00:00",
  "last_update_user": "a53f2459-3d86-4195-9243-48c3e35c0ee0",
  "active": true,
  "db_login": "sample string 4",
  "db_name": "sample string 5",
  "db_password": "sample string 6",
  "db_source": "sample string 7",
  "description": "sample string 8",
  "id": "dd2539ea-6884-4b63-bda9-773032623e3d",
  "local_ip": "sample string 10",
  "local_name": "sample string 11",
  "mac_address": "sample string 12",
  "site_id": "4706f080-edd2-43a5-a46f-adf2e01eb146",
  "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 4</db_login>
  <db_name>sample string 5</db_name>
  <db_password>sample string 6</db_password>
  <db_source>sample string 7</db_source>
  <description>sample string 8</description>
  <id>dd2539ea-6884-4b63-bda9-773032623e3d</id>
  <iscleanroom>true</iscleanroom>
  <isdistribution>true</isdistribution>
  <local_ip>sample string 10</local_ip>
  <local_name>sample string 11</local_name>
  <mac_address>sample string 12</mac_address>
  <site_id>4706f080-edd2-43a5-a46f-adf2e01eb146</site_id>
  <last_update>2026-06-09T21:56:01.4677804+00:00</last_update>
  <last_update_user>a53f2459-3d86-4195-9243-48c3e35c0ee0</last_update_user>
</communication_server>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CommunicationServerSyncViewModel'.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"35ebf2b0-65a8-4673-980e-f481fe3e9df6"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">35ebf2b0-65a8-4673-980e-f481fe3e9df6</guid>