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

Update an existing client in SI

Request Information

URI Parameters

None.

Body Parameters

UpdateClient
NameDescriptionTypeAdditional information
IntegrationId

Integration Id of client to update (Must pass either IntegrationId Or Client Number)

string

None.

Number

Number of client to update (Must pass either IntegrationId Or Client Number)

string

None.

UpdateFields

List of UpdateFields for the client. Each UpdateField has a Id and a Value.

Collection of UpdateClientField

None.

SiteAddress

Client Site Address

Address

None.

BillingAddress

Client Billing Address

Address

None.

Request Formats

application/json, text/json

Sample:
{
  "IntegrationId": "sample string 1",
  "Number": "sample string 2",
  "UpdateFields": [
    {
      "ClientFieldId": 64,
      "Value": "sample string 2"
    },
    {
      "ClientFieldId": 64,
      "Value": "sample string 2"
    }
  ],
  "SiteAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  },
  "BillingAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  }
}

application/xml, text/xml

Sample:
<UpdateClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <BillingAddress>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Fax>sample string 8</Fax>
    <Phone>sample string 7</Phone>
    <PostalCode>sample string 5</PostalCode>
    <State>sample string 4</State>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
  </BillingAddress>
  <IntegrationId>sample string 1</IntegrationId>
  <Number>sample string 2</Number>
  <SiteAddress>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Fax>sample string 8</Fax>
    <Phone>sample string 7</Phone>
    <PostalCode>sample string 5</PostalCode>
    <State>sample string 4</State>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
  </SiteAddress>
  <UpdateFields>
    <UpdateClientField>
      <ClientFieldId>64</ClientFieldId>
      <Value>sample string 2</Value>
    </UpdateClientField>
    <UpdateClientField>
      <ClientFieldId>64</ClientFieldId>
      <Value>sample string 2</Value>
    </UpdateClientField>
  </UpdateFields>
</UpdateClient>

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

Response Information

Resource Description

PublishResponse
NameDescriptionTypeAdditional information
MessageId

Check the status of the transction using this Message Id

globally unique identifier

None.

Message

Sucess Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MessageId": "98d3a3a0-84a8-4b47-bc8e-c23bd7a63a84",
  "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>98d3a3a0-84a8-4b47-bc8e-c23bd7a63a84</MessageId>
</PublishResponse>