PUT api/clients/{clientId}/address

Creates or updates an address for a client.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client ID.	integer	Required

Body Parameters

The registered address.

RegisteredAddress

Name	Description	Type	Additional information
AddressTypeCode	Gets or sets the code of the type of address this is.	string	None.
Dates	Gets or sets the dates during which this address is in effect. May be null, which means that the address is always in effect.	DateRange	None.
LocationID	The location associated with this registered address (if any)	integer	None.
ID	Gets or sets an optional ID that may be used by the server to help identify the address or location.	integer	None.
Description	A description of the location	string	None.
Category	A category that can be used to group the location	string	None.
CategoryId	A category that can be used to group the location	string	None.
Name	The name of the location	string	None.
Latitude	The latitude of the location	decimal number	None.
Longitude	the longitude of the location	decimal number	None.
StreetNumber	The street number for the location	string	None.
OnStreet	The name of the street that the location is on	string	None.
AtStreet	An intersecting street	string	None.
City	The city the location is in.	string	None.
State	State/Province	string	None.
PostalCode	postal/zip code	string	None.
ItemType	The type of location	LocationItemType	None.
InternalType	Gets or sets the internal location type, which is used to help distinguish recent locations that are based on predefined locations vs addresses.	LocationItemType	None.
Unit	Unit number (eg apartment number)	string	None.
Comments	Any comments/instructions associated with this location	string	None.
IsGeocoded	Whether the latitude and longitude are available for this location. This property was introduced during 1.8.0 and will default to "true" if not specified in order to maintain backwards compatibility.	boolean	None.
Contact	A contact associated with the location (may be null)	Contact	None.
Country	Gets or sets the location's country As of Oct 2019, this field isn't used when booking a trip, and is primarily used to capture more information from google addresses in order to display them properly.	string	None.
StopCode	The stop code of this location (if any)	string	None.
ProcedureModifier		string	None.
TimeZoneId	The time zone id of this location	string	None.

Request Formats

application/json, text/json

Sample:

{
  "addressTypeCode": "sample string 1",
  "dates": null,
  "locationID": 1,
  "id": 1,
  "description": "sample string 2",
  "category": "sample string 3",
  "categoryId": "sample string 4",
  "name": "sample string 5",
  "latitude": 1.1,
  "longitude": 1.1,
  "streetNumber": "sample string 6",
  "onStreet": "sample string 7",
  "atStreet": "sample string 8",
  "city": "sample string 9",
  "state": "sample string 10",
  "postalCode": "sample string 11",
  "itemType": 0,
  "internalType": 0,
  "unit": "sample string 12",
  "comments": "sample string 13",
  "isGeocoded": true,
  "contact": {
    "id": 1,
    "referenceId": "sample string 2",
    "contactType": "sample string 3",
    "firstName": "sample string 4",
    "lastName": "sample string 5",
    "comments": "sample string 6",
    "details": [
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      },
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      }
    ]
  },
  "country": "sample string 15",
  "stopCode": "sample string 16",
  "procedureModifier": "sample string 17",
  "timeZoneId": "sample string 18"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the updated registered address

RegisteredAddress

Name	Description	Type	Additional information
AddressTypeCode	Gets or sets the code of the type of address this is.	string	None.
Dates	Gets or sets the dates during which this address is in effect. May be null, which means that the address is always in effect.	DateRange	None.
LocationID	The location associated with this registered address (if any)	integer	None.
ID	Gets or sets an optional ID that may be used by the server to help identify the address or location.	integer	None.
Description	A description of the location	string	None.
Category	A category that can be used to group the location	string	None.
CategoryId	A category that can be used to group the location	string	None.
Name	The name of the location	string	None.
Latitude	The latitude of the location	decimal number	None.
Longitude	the longitude of the location	decimal number	None.
StreetNumber	The street number for the location	string	None.
OnStreet	The name of the street that the location is on	string	None.
AtStreet	An intersecting street	string	None.
City	The city the location is in.	string	None.
State	State/Province	string	None.
PostalCode	postal/zip code	string	None.
ItemType	The type of location	LocationItemType	None.
InternalType	Gets or sets the internal location type, which is used to help distinguish recent locations that are based on predefined locations vs addresses.	LocationItemType	None.
Unit	Unit number (eg apartment number)	string	None.
Comments	Any comments/instructions associated with this location	string	None.
IsGeocoded	Whether the latitude and longitude are available for this location. This property was introduced during 1.8.0 and will default to "true" if not specified in order to maintain backwards compatibility.	boolean	None.
Contact	A contact associated with the location (may be null)	Contact	None.
Country	Gets or sets the location's country As of Oct 2019, this field isn't used when booking a trip, and is primarily used to capture more information from google addresses in order to display them properly.	string	None.
StopCode	The stop code of this location (if any)	string	None.
ProcedureModifier		string	None.
TimeZoneId	The time zone id of this location	string	None.

Response Formats

application/json, text/json

Sample:

{
  "addressTypeCode": "sample string 1",
  "dates": null,
  "locationID": 1,
  "id": 1,
  "description": "sample string 2",
  "category": "sample string 3",
  "categoryId": "sample string 4",
  "name": "sample string 5",
  "latitude": 1.1,
  "longitude": 1.1,
  "streetNumber": "sample string 6",
  "onStreet": "sample string 7",
  "atStreet": "sample string 8",
  "city": "sample string 9",
  "state": "sample string 10",
  "postalCode": "sample string 11",
  "itemType": 0,
  "internalType": 0,
  "unit": "sample string 12",
  "comments": "sample string 13",
  "isGeocoded": true,
  "contact": {
    "id": 1,
    "referenceId": "sample string 2",
    "contactType": "sample string 3",
    "firstName": "sample string 4",
    "lastName": "sample string 5",
    "comments": "sample string 6",
    "details": [
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      },
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      }
    ]
  },
  "country": "sample string 15",
  "stopCode": "sample string 16",
  "procedureModifier": "sample string 17",
  "timeZoneId": "sample string 18"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.