PUT api/Locations/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

LocationDto
NameDescriptionTypeAdditional information
Id

integer

None.

ClientId

integer

None.

ChainId

integer

None.

AccountNumber

integer

None.

Name

string

Required

String length: inclusive between 0 and 100

DateStarted

date

None.

DateOpened

date

None.

DateClosed

date

None.

TimeZoneId

integer

None.

LocationTypeId

integer

None.

Enabled

boolean

None.

ClientIdentity

string

String length: inclusive between 0 and 36

TaxRate

decimal number

None.

IntegrationTypeId

integer

None.

EnabledForWeb

boolean

None.

FriendlyName

string

String length: inclusive between 0 and 100

LocationAddresses

Collection of LocationAddressDto

None.

LocationPhones

Collection of LocationPhoneDto

None.

SupplierAccount

LocationSupplierAccountDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ClientId": 2,
  "ChainId": 3,
  "AccountNumber": 4,
  "Name": "sample string 5",
  "DateStarted": "2026-04-29T22:07:04.5070798+00:00",
  "DateOpened": "2026-04-29T22:07:04.5070798+00:00",
  "DateClosed": "2026-04-29T22:07:04.5070798+00:00",
  "TimeZoneId": 1,
  "LocationTypeId": 7,
  "Enabled": true,
  "ClientIdentity": "sample string 9",
  "TaxRate": 1.0,
  "IntegrationTypeId": 1,
  "EnabledForWeb": true,
  "FriendlyName": "sample string 11",
  "LocationAddresses": [
    {
      "AddressId": 1,
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "City": "sample string 4",
      "Zip": "sample string 5",
      "State": "sample string 6",
      "IsPreferred": true,
      "AddressTypeId": 1
    },
    {
      "AddressId": 1,
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "City": "sample string 4",
      "Zip": "sample string 5",
      "State": "sample string 6",
      "IsPreferred": true,
      "AddressTypeId": 1
    }
  ],
  "LocationPhones": [
    {
      "PhoneId": 1,
      "PhoneNumber": 2,
      "PhoneExt": 1,
      "IsPreferred": true,
      "PhoneTypeId": 1
    },
    {
      "PhoneId": 1,
      "PhoneNumber": 2,
      "PhoneExt": 1,
      "IsPreferred": true,
      "PhoneTypeId": 1
    }
  ],
  "SupplierAccount": {
    "SupplierId": 1,
    "SupplierName": "sample string 2",
    "AccountNumber": "sample string 3",
    "SecondaryAccountNumber": "sample string 4"
  }
}

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

Response Information

Resource Description

LocationFullDto
NameDescriptionTypeAdditional information
DisplayName

string

None.

Id

integer

None.

ClientId

integer

None.

ChainId

integer

None.

AccountNumber

integer

None.

Name

string

Required

String length: inclusive between 0 and 100

DateStarted

date

None.

DateOpened

date

None.

DateClosed

date

None.

TimeZoneId

integer

None.

LocationTypeId

integer

None.

Enabled

boolean

None.

ClientIdentity

string

String length: inclusive between 0 and 36

TaxRate

decimal number

None.

IntegrationTypeId

integer

None.

EnabledForWeb

boolean

None.

FriendlyName

string

String length: inclusive between 0 and 100

LocationAddresses

Collection of LocationAddressDto

None.

LocationPhones

Collection of LocationPhoneDto

None.

SupplierAccount

LocationSupplierAccountDto

None.

Response Formats

application/json, text/json

Sample:
{
  "DisplayName": "sample string 1",
  "Id": 2,
  "ClientId": 3,
  "ChainId": 4,
  "AccountNumber": 5,
  "Name": "sample string 6",
  "DateStarted": "2026-04-29T22:07:04.5226676+00:00",
  "DateOpened": "2026-04-29T22:07:04.5226676+00:00",
  "DateClosed": "2026-04-29T22:07:04.5226676+00:00",
  "TimeZoneId": 1,
  "LocationTypeId": 8,
  "Enabled": true,
  "ClientIdentity": "sample string 10",
  "TaxRate": 1.0,
  "IntegrationTypeId": 1,
  "EnabledForWeb": true,
  "FriendlyName": "sample string 12",
  "LocationAddresses": [
    {
      "AddressId": 1,
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "City": "sample string 4",
      "Zip": "sample string 5",
      "State": "sample string 6",
      "IsPreferred": true,
      "AddressTypeId": 1
    },
    {
      "AddressId": 1,
      "Line1": "sample string 2",
      "Line2": "sample string 3",
      "City": "sample string 4",
      "Zip": "sample string 5",
      "State": "sample string 6",
      "IsPreferred": true,
      "AddressTypeId": 1
    }
  ],
  "LocationPhones": [
    {
      "PhoneId": 1,
      "PhoneNumber": 2,
      "PhoneExt": 1,
      "IsPreferred": true,
      "PhoneTypeId": 1
    },
    {
      "PhoneId": 1,
      "PhoneNumber": 2,
      "PhoneExt": 1,
      "IsPreferred": true,
      "PhoneTypeId": 1
    }
  ],
  "SupplierAccount": {
    "SupplierId": 1,
    "SupplierName": "sample string 2",
    "AccountNumber": "sample string 3",
    "SecondaryAccountNumber": "sample string 4"
  }
}