PUT api/alternateaddresses/{id}

Update Alternate Address

Request Information

Authentication

This method requires device authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

integer

Required

Body Parameters

AlternateAddressUpdate
NameDescriptionTypeAdditional information
Id

Alternate Address Id. Primary key of the unit alternate address table

integer

None.

Address1

Alternate Address 1.

string

None.

Address2

Alternate Address 2.

string

None.

City

Alternate Address City.

string

None.

State

Alternate Address State.

string

None.

Zip

Alternate Address Zip Code.

string

None.

CountryCode

Alternate Address Country.

string

None.

IsBillingAddress

Billing Address. This value determines whether the alternate address record is considered the official billing address.

boolean

None.

IsCareOf

Is the first line Care Of information?

boolean

None.

UserId

UserId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Address1": "sample string 2",
  "Address2": "sample string 3",
  "City": "sample string 4",
  "State": "sample string 5",
  "Zip": "sample string 6",
  "CountryCode": "sample string 7",
  "IsBillingAddress": true,
  "IsCareOf": true,
  "UserId": 10
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

This method has no specific response - It returns an empty success response if it completes without error.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)
  • 112: InvalidOperation
    (The operation is not valid., Conflict)
  • 113: WriteOperationFailed
    (The requested operation failed., Conflict)
  • 109: MissingRequiredJsonParameter
    (Invalid request format. A required parameter in the request body was not specified for this request., BadRequest)
  • 114: InvalidJsonParameterValue
    (Invalid request format. The value provided for one of the parameters in the request body was not in the correct format., BadRequest)