POST https://api.d-tools.com/SI/Publish/Clients

Publish a list of clients to SI.

Request Information

URI Parameters

None.

Body Parameters

The client list.

Name	Description	Type	Additional information
Id	Unique Id for the client (Required)	string	None.
Name	Name for the client list (Required)	string	None.
Description	Client list description	string	None.
Clients	Client list.	Collection of Client	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Clients": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Number": "sample string 3",
      "IntegrationId": "sample string 4",
      "Phone": "sample string 5",
      "Fax": "sample string 6",
      "Email": "sample string 7",
      "WebSite": "sample string 8",
      "ClientType": "sample string 9",
      "LeadSource": "sample string 10",
      "Tax": "sample string 11",
      "LaborTax": "sample string 12",
      "CreatedOn": "2025-03-06T03:16:01.2708059+00:00",
      "UpdatedOn": "2025-03-06T03:16:01.2708059+00:00",
      "UpdatedBy": "sample string 15",
      "PublishedBy": "sample string 16",
      "ClientAddresses": [
        {
          "TypeId": 64,
          "Name": "sample string 2",
          "Street1": "sample string 3",
          "Street2": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "PostalCode": "sample string 7",
          "Country": "sample string 8",
          "Phone": "sample string 9",
          "Fax": "sample string 10"
        },
        {
          "TypeId": 64,
          "Name": "sample string 2",
          "Street1": "sample string 3",
          "Street2": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "PostalCode": "sample string 7",
          "Country": "sample string 8",
          "Phone": "sample string 9",
          "Fax": "sample string 10"
        }
      ],
      "ClientContacts": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Company": "sample string 3",
          "Title": "sample string 4",
          "Email": "sample string 5",
          "Phone": "sample string 6",
          "Fax": "sample string 7",
          "Mobile": "sample string 8",
          "Street1": "sample string 9",
          "Street2": "sample string 10",
          "City": "sample string 11",
          "State": "sample string 12",
          "PostalCode": "sample string 13",
          "Country": "sample string 14",
          "Notes": "sample string 15"
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Company": "sample string 3",
          "Title": "sample string 4",
          "Email": "sample string 5",
          "Phone": "sample string 6",
          "Fax": "sample string 7",
          "Mobile": "sample string 8",
          "Street1": "sample string 9",
          "Street2": "sample string 10",
          "City": "sample string 11",
          "State": "sample string 12",
          "PostalCode": "sample string 13",
          "Country": "sample string 14",
          "Notes": "sample string 15"
        }
      ]
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Number": "sample string 3",
      "IntegrationId": "sample string 4",
      "Phone": "sample string 5",
      "Fax": "sample string 6",
      "Email": "sample string 7",
      "WebSite": "sample string 8",
      "ClientType": "sample string 9",
      "LeadSource": "sample string 10",
      "Tax": "sample string 11",
      "LaborTax": "sample string 12",
      "CreatedOn": "2025-03-06T03:16:01.2708059+00:00",
      "UpdatedOn": "2025-03-06T03:16:01.2708059+00:00",
      "UpdatedBy": "sample string 15",
      "PublishedBy": "sample string 16",
      "ClientAddresses": [
        {
          "TypeId": 64,
          "Name": "sample string 2",
          "Street1": "sample string 3",
          "Street2": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "PostalCode": "sample string 7",
          "Country": "sample string 8",
          "Phone": "sample string 9",
          "Fax": "sample string 10"
        },
        {
          "TypeId": 64,
          "Name": "sample string 2",
          "Street1": "sample string 3",
          "Street2": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "PostalCode": "sample string 7",
          "Country": "sample string 8",
          "Phone": "sample string 9",
          "Fax": "sample string 10"
        }
      ],
      "ClientContacts": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Company": "sample string 3",
          "Title": "sample string 4",
          "Email": "sample string 5",
          "Phone": "sample string 6",
          "Fax": "sample string 7",
          "Mobile": "sample string 8",
          "Street1": "sample string 9",
          "Street2": "sample string 10",
          "City": "sample string 11",
          "State": "sample string 12",
          "PostalCode": "sample string 13",
          "Country": "sample string 14",
          "Notes": "sample string 15"
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Company": "sample string 3",
          "Title": "sample string 4",
          "Email": "sample string 5",
          "Phone": "sample string 6",
          "Fax": "sample string 7",
          "Mobile": "sample string 8",
          "Street1": "sample string 9",
          "Street2": "sample string 10",
          "City": "sample string 11",
          "State": "sample string 12",
          "PostalCode": "sample string 13",
          "Country": "sample string 14",
          "Notes": "sample string 15"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ClientList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <Clients>
    <Client>
      <ClientAddresses>
        <ClientAddress>
          <City>sample string 5</City>
          <Country>sample string 8</Country>
          <Fax>sample string 10</Fax>
          <Phone>sample string 9</Phone>
          <PostalCode>sample string 7</PostalCode>
          <State>sample string 6</State>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <Name>sample string 2</Name>
          <TypeId>64</TypeId>
        </ClientAddress>
        <ClientAddress>
          <City>sample string 5</City>
          <Country>sample string 8</Country>
          <Fax>sample string 10</Fax>
          <Phone>sample string 9</Phone>
          <PostalCode>sample string 7</PostalCode>
          <State>sample string 6</State>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <Name>sample string 2</Name>
          <TypeId>64</TypeId>
        </ClientAddress>
      </ClientAddresses>
      <ClientContacts>
        <ClientContact>
          <City>sample string 11</City>
          <Company>sample string 3</Company>
          <Country>sample string 14</Country>
          <Email>sample string 5</Email>
          <Fax>sample string 7</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Mobile>sample string 8</Mobile>
          <Notes>sample string 15</Notes>
          <Phone>sample string 6</Phone>
          <PostalCode>sample string 13</PostalCode>
          <State>sample string 12</State>
          <Street1>sample string 9</Street1>
          <Street2>sample string 10</Street2>
          <Title>sample string 4</Title>
        </ClientContact>
        <ClientContact>
          <City>sample string 11</City>
          <Company>sample string 3</Company>
          <Country>sample string 14</Country>
          <Email>sample string 5</Email>
          <Fax>sample string 7</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Mobile>sample string 8</Mobile>
          <Notes>sample string 15</Notes>
          <Phone>sample string 6</Phone>
          <PostalCode>sample string 13</PostalCode>
          <State>sample string 12</State>
          <Street1>sample string 9</Street1>
          <Street2>sample string 10</Street2>
          <Title>sample string 4</Title>
        </ClientContact>
      </ClientContacts>
      <ClientType>sample string 9</ClientType>
      <CreatedOn>2025-03-06T03:16:01.2708059+00:00</CreatedOn>
      <Email>sample string 7</Email>
      <Fax>sample string 6</Fax>
      <Id>sample string 1</Id>
      <IntegrationId>sample string 4</IntegrationId>
      <LaborTax>sample string 12</LaborTax>
      <LeadSource>sample string 10</LeadSource>
      <Name>sample string 2</Name>
      <Number>sample string 3</Number>
      <Phone>sample string 5</Phone>
      <PublishedBy>sample string 16</PublishedBy>
      <Tax>sample string 11</Tax>
      <UpdatedBy>sample string 15</UpdatedBy>
      <UpdatedOn>2025-03-06T03:16:01.2708059+00:00</UpdatedOn>
      <WebSite>sample string 8</WebSite>
    </Client>
    <Client>
      <ClientAddresses>
        <ClientAddress>
          <City>sample string 5</City>
          <Country>sample string 8</Country>
          <Fax>sample string 10</Fax>
          <Phone>sample string 9</Phone>
          <PostalCode>sample string 7</PostalCode>
          <State>sample string 6</State>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <Name>sample string 2</Name>
          <TypeId>64</TypeId>
        </ClientAddress>
        <ClientAddress>
          <City>sample string 5</City>
          <Country>sample string 8</Country>
          <Fax>sample string 10</Fax>
          <Phone>sample string 9</Phone>
          <PostalCode>sample string 7</PostalCode>
          <State>sample string 6</State>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <Name>sample string 2</Name>
          <TypeId>64</TypeId>
        </ClientAddress>
      </ClientAddresses>
      <ClientContacts>
        <ClientContact>
          <City>sample string 11</City>
          <Company>sample string 3</Company>
          <Country>sample string 14</Country>
          <Email>sample string 5</Email>
          <Fax>sample string 7</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Mobile>sample string 8</Mobile>
          <Notes>sample string 15</Notes>
          <Phone>sample string 6</Phone>
          <PostalCode>sample string 13</PostalCode>
          <State>sample string 12</State>
          <Street1>sample string 9</Street1>
          <Street2>sample string 10</Street2>
          <Title>sample string 4</Title>
        </ClientContact>
        <ClientContact>
          <City>sample string 11</City>
          <Company>sample string 3</Company>
          <Country>sample string 14</Country>
          <Email>sample string 5</Email>
          <Fax>sample string 7</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Mobile>sample string 8</Mobile>
          <Notes>sample string 15</Notes>
          <Phone>sample string 6</Phone>
          <PostalCode>sample string 13</PostalCode>
          <State>sample string 12</State>
          <Street1>sample string 9</Street1>
          <Street2>sample string 10</Street2>
          <Title>sample string 4</Title>
        </ClientContact>
      </ClientContacts>
      <ClientType>sample string 9</ClientType>
      <CreatedOn>2025-03-06T03:16:01.2708059+00:00</CreatedOn>
      <Email>sample string 7</Email>
      <Fax>sample string 6</Fax>
      <Id>sample string 1</Id>
      <IntegrationId>sample string 4</IntegrationId>
      <LaborTax>sample string 12</LaborTax>
      <LeadSource>sample string 10</LeadSource>
      <Name>sample string 2</Name>
      <Number>sample string 3</Number>
      <Phone>sample string 5</Phone>
      <PublishedBy>sample string 16</PublishedBy>
      <Tax>sample string 11</Tax>
      <UpdatedBy>sample string 15</UpdatedBy>
      <UpdatedOn>2025-03-06T03:16:01.2708059+00:00</UpdatedOn>
      <WebSite>sample string 8</WebSite>
    </Client>
  </Clients>
  <Description>sample string 3</Description>
  <Id>sample string 1</Id>
  <Name>sample string 2</Name>
</ClientList>

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 'ClientList'.

Response Information

Resource Description

PublishResponse

Name	Description	Type	Additional information
MessageId	Check the status of the transaction using this Message Id	globally unique identifier	None.
Message	Success Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "MessageId": "06e4cd14-bdb9-411a-ae2e-559fd56899a7",
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<PublishResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <Message>sample string 2</Message>
  <MessageId>06e4cd14-bdb9-411a-ae2e-559fd56899a7</MessageId>
</PublishResponse>