PUT api/CUSTOMER_ADDRESSES/{id}?foreigns={foreigns}

Update a single CUSTOMER_ADDRESSES record

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Obligatory. The ADDRESS_ID value of the record passed that need to be updated

integer

Required

foreigns

Optional. Default value is false. True=> Include nested foreign objects within reply. False=> Do NOT Include nested foreign objects within reply

boolean

Default value is False

Body Parameters

Obligatory. The new updated CUSTOMER_ADDRESSES object that need to be updated

CUSTOMER_ADDRESSES
NameDescriptionTypeAdditional information
ADDRESS_ID

integer

None.

ADDRESS_TITLE

string

Required

String length: inclusive between 0 and 100

ADDRESS_DETAIL

string

Required

String length: inclusive between 0 and 500

FK_CUSTOMER

integer

None.

FK_EMIRATE

integer

None.

LATITUDE

string

String length: inclusive between 0 and 30

LONGITUDE

string

String length: inclusive between 0 and 30

CUSTOMERS

CUSTOMERS

None.

EMIRATES

EMIRATES

None.

Request Formats

application/json, text/json

Sample:
{
  "ADDRESS_ID": 1,
  "ADDRESS_TITLE": "sample string 2",
  "ADDRESS_DETAIL": "sample string 3",
  "FK_CUSTOMER": 4,
  "FK_EMIRATE": 5,
  "LATITUDE": "sample string 6",
  "LONGITUDE": "sample string 7",
  "CUSTOMERS": {
    "CUSTOMER_ID": 1,
    "CUSTOMER_ID_IMAGE": "3b2cdaab-b4ad-4e88-a4bf-9aec8d5615f3",
    "CUSTOMER_NAME_AR": "sample string 2",
    "CUSTOMER_NAME_EN": "sample string 3",
    "FK_EMIRATE": 1,
    "EMAIL": "sample string 4",
    "MOBILE_NO": "sample string 5",
    "LOGIN_PASSWORD": "sample string 6",
    "FK_MOBILE_COUNTRY": 7,
    "ACTIVE": true,
    "NOTES": "sample string 9",
    "LAST_NOTIFY_DELETE": "2025-12-08T00:36:06.314Z",
    "FK_USER": 1,
    "FK_GROUP": 1,
    "COUNTRIES": {
      "COUNTRY_ID": 1,
      "COUNTRY_NO": 2,
      "CALLING_CODE": "sample string 3",
      "COUNTRY_NAME_AR": "sample string 4",
      "COUNTRY_NAME_EN": "sample string 5",
      "COUNTRY_CODE2": "sample string 6",
      "COUNTRY_CODE3": "sample string 7"
    },
    "EMIRATES": {
      "EMIRATE_ID": 1,
      "EMIRATE_NAME_AR": "sample string 2",
      "EMIRATE_NAME_EN": "sample string 3"
    }
  },
  "EMIRATES": {
    "EMIRATE_ID": 1,
    "EMIRATE_NAME_AR": "sample string 2",
    "EMIRATE_NAME_EN": "sample string 3"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CUSTOMER_ADDRESSES_CMD_RESPONSE
NameDescriptionTypeAdditional information
Status

Status

None.

DATA

Collection of CUSTOMER_ADDRESSES

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": {
    "Success": true,
    "MessageEn": "sample string 2",
    "MessageAr": "sample string 3",
    "DetailedMessage": "sample string 4",
    "Code": 0,
    "CartErrors": [
      {
        "ResultStatusCode": 0,
        "CartId": 1,
        "CorrectValue": {},
        "MessageEn": "sample string 2",
        "MessageAr": "sample string 3",
        "CartCorrectAction": 0
      },
      {
        "ResultStatusCode": 0,
        "CartId": 1,
        "CorrectValue": {},
        "MessageEn": "sample string 2",
        "MessageAr": "sample string 3",
        "CartCorrectAction": 0
      }
    ]
  },
  "DATA": [
    {
      "ADDRESS_ID": 1,
      "ADDRESS_TITLE": "sample string 2",
      "ADDRESS_DETAIL": "sample string 3",
      "FK_CUSTOMER": 4,
      "FK_EMIRATE": 5,
      "LATITUDE": "sample string 6",
      "LONGITUDE": "sample string 7",
      "CUSTOMERS": {
        "CUSTOMER_ID": 1,
        "CUSTOMER_ID_IMAGE": "b1d0b240-e5e0-47bf-bb9f-fd809f3ae060",
        "CUSTOMER_NAME_AR": "sample string 2",
        "CUSTOMER_NAME_EN": "sample string 3",
        "FK_EMIRATE": 1,
        "EMAIL": "sample string 4",
        "MOBILE_NO": "sample string 5",
        "LOGIN_PASSWORD": "sample string 6",
        "FK_MOBILE_COUNTRY": 7,
        "ACTIVE": true,
        "NOTES": "sample string 9",
        "LAST_NOTIFY_DELETE": "2025-12-08T00:36:06.314Z",
        "FK_USER": 1,
        "FK_GROUP": 1,
        "COUNTRIES": {
          "COUNTRY_ID": 1,
          "COUNTRY_NO": 2,
          "CALLING_CODE": "sample string 3",
          "COUNTRY_NAME_AR": "sample string 4",
          "COUNTRY_NAME_EN": "sample string 5",
          "COUNTRY_CODE2": "sample string 6",
          "COUNTRY_CODE3": "sample string 7"
        },
        "EMIRATES": {
          "EMIRATE_ID": 1,
          "EMIRATE_NAME_AR": "sample string 2",
          "EMIRATE_NAME_EN": "sample string 3"
        }
      },
      "EMIRATES": {
        "EMIRATE_ID": 1,
        "EMIRATE_NAME_AR": "sample string 2",
        "EMIRATE_NAME_EN": "sample string 3"
      }
    },
    {
      "ADDRESS_ID": 1,
      "ADDRESS_TITLE": "sample string 2",
      "ADDRESS_DETAIL": "sample string 3",
      "FK_CUSTOMER": 4,
      "FK_EMIRATE": 5,
      "LATITUDE": "sample string 6",
      "LONGITUDE": "sample string 7",
      "CUSTOMERS": {
        "CUSTOMER_ID": 1,
        "CUSTOMER_ID_IMAGE": "b1d0b240-e5e0-47bf-bb9f-fd809f3ae060",
        "CUSTOMER_NAME_AR": "sample string 2",
        "CUSTOMER_NAME_EN": "sample string 3",
        "FK_EMIRATE": 1,
        "EMAIL": "sample string 4",
        "MOBILE_NO": "sample string 5",
        "LOGIN_PASSWORD": "sample string 6",
        "FK_MOBILE_COUNTRY": 7,
        "ACTIVE": true,
        "NOTES": "sample string 9",
        "LAST_NOTIFY_DELETE": "2025-12-08T00:36:06.314Z",
        "FK_USER": 1,
        "FK_GROUP": 1,
        "COUNTRIES": {
          "COUNTRY_ID": 1,
          "COUNTRY_NO": 2,
          "CALLING_CODE": "sample string 3",
          "COUNTRY_NAME_AR": "sample string 4",
          "COUNTRY_NAME_EN": "sample string 5",
          "COUNTRY_CODE2": "sample string 6",
          "COUNTRY_CODE3": "sample string 7"
        },
        "EMIRATES": {
          "EMIRATE_ID": 1,
          "EMIRATE_NAME_AR": "sample string 2",
          "EMIRATE_NAME_EN": "sample string 3"
        }
      },
      "EMIRATES": {
        "EMIRATE_ID": 1,
        "EMIRATE_NAME_AR": "sample string 2",
        "EMIRATE_NAME_EN": "sample string 3"
      }
    }
  ]
}