PATCH api/settings/update

Request Information

URI Parameters

None.

Body Parameters

CompanySettingsUpdateDTO
NameDescriptionTypeAdditional information
UpdateComments

string

Required

OrgDisplayName

string

Required

SoapUseOtherCompanies

boolean

Required

SMSSenderId

string

Required

SMSClient_id

string

Required

SMSApiKey

string

Required

SMSAccessKey

string

Required

SupportContactPhone

string

Required

SoapScheme

string

Required

SoapServer

string

Required

SoapInstance

string

Required

SoapPort

integer

Required

SoapUsername

string

Required

SoapPassword

string

Required

SoapDefaultCompany

string

Required

FrontendURL

string

Required

Request Formats

application/json, text/json

Sample:
{
  "UpdateComments": "sample string 1",
  "OrgDisplayName": "sample string 2",
  "SoapUseOtherCompanies": true,
  "SMSSenderId": "sample string 4",
  "SMSClient_id": "sample string 5",
  "SMSApiKey": "sample string 6",
  "SMSAccessKey": "sample string 7",
  "SupportContactPhone": "sample string 8",
  "SoapScheme": "sample string 9",
  "SoapServer": "sample string 10",
  "SoapInstance": "sample string 11",
  "SoapPort": 12,
  "SoapUsername": "sample string 13",
  "SoapPassword": "sample string 14",
  "SoapDefaultCompany": "sample string 15",
  "FrontendURL": "sample string 16"
}

application/xml, text/xml

Sample:
<CompanySettingsUpdateDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/back_end.Models.DTOs">
  <FrontendURL>sample string 16</FrontendURL>
  <OrgDisplayName>sample string 2</OrgDisplayName>
  <SMSAccessKey>sample string 7</SMSAccessKey>
  <SMSApiKey>sample string 6</SMSApiKey>
  <SMSClient_id>sample string 5</SMSClient_id>
  <SMSSenderId>sample string 4</SMSSenderId>
  <SoapDefaultCompany>sample string 15</SoapDefaultCompany>
  <SoapInstance>sample string 11</SoapInstance>
  <SoapPassword>sample string 14</SoapPassword>
  <SoapPort>12</SoapPort>
  <SoapScheme>sample string 9</SoapScheme>
  <SoapServer>sample string 10</SoapServer>
  <SoapUseOtherCompanies>true</SoapUseOtherCompanies>
  <SoapUsername>sample string 13</SoapUsername>
  <SupportContactPhone>sample string 8</SupportContactPhone>
  <UpdateComments>sample string 1</UpdateComments>
</CompanySettingsUpdateDTO>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.