PUT fxo/Entity

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
entity	Update_Entity	Required
home_address	Address	None.
alternate_address	Address	None.
ship_address	Address	None.
bill_address	Address	None.
office_address	Address	None.
registered_office_address	Address	None.
internet	WebBankContact	None.
phone	PhoneBankContact	None.
customerservice	EntityCustomerService	None.
internal_use	InternalUse	None.
corporate_profile	CorporateProfile	None.
individual_profile	IndividualProfile	None.
indv_address	IndividualAddress	None.
flex_field	FlexField	None.

Request Formats

application/json, text/json

Sample:

{
  "entity": {
    "record": {
      "value": "sample string 1",
      "id": 2
    },
    "name": "sample string 1",
    "alias": "sample string 2",
    "status": {
      "value": "sample string 1",
      "id": 2
    },
    "entity_class": {
      "value": "sample string 1",
      "id": 2
    },
    "entity_type": {
      "value": "sample string 1",
      "id": 2
    },
    "public_to": {
      "value": "sample string 1",
      "id": 2
    }
  },
  "home_address": {
    "description": "sample string 1",
    "street_address": "sample string 2",
    "post_code": "sample string 3",
    "city": "sample string 4",
    "province": "sample string 5",
    "other": "sample string 6",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "is_default": true
  },
  "alternate_address": {
    "description": "sample string 1",
    "street_address": "sample string 2",
    "post_code": "sample string 3",
    "city": "sample string 4",
    "province": "sample string 5",
    "other": "sample string 6",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "is_default": true
  },
  "ship_address": {
    "description": "sample string 1",
    "street_address": "sample string 2",
    "post_code": "sample string 3",
    "city": "sample string 4",
    "province": "sample string 5",
    "other": "sample string 6",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "is_default": true
  },
  "bill_address": {
    "description": "sample string 1",
    "street_address": "sample string 2",
    "post_code": "sample string 3",
    "city": "sample string 4",
    "province": "sample string 5",
    "other": "sample string 6",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "is_default": true
  },
  "office_address": {
    "description": "sample string 1",
    "street_address": "sample string 2",
    "post_code": "sample string 3",
    "city": "sample string 4",
    "province": "sample string 5",
    "other": "sample string 6",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "is_default": true
  },
  "registered_office_address": {
    "description": "sample string 1",
    "street_address": "sample string 2",
    "post_code": "sample string 3",
    "city": "sample string 4",
    "province": "sample string 5",
    "other": "sample string 6",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "is_default": true
  },
  "internet": {
    "confirmation_email": "sample string 1",
    "email": "sample string 2",
    "alternate_email": "sample string 3",
    "web_site": "sample string 4"
  },
  "phone": {
    "assistant": "sample string 1",
    "business": "sample string 2",
    "business_2": "sample string 3",
    "business_fax": "sample string 4",
    "business_fax_2": "sample string 5",
    "car": "sample string 6",
    "company": "sample string 7",
    "direct": "sample string 8",
    "alternate_home": "sample string 9",
    "home": "sample string 10",
    "isdn": "sample string 11",
    "mobile": "sample string 12",
    "other": "sample string 13",
    "other_fax": "sample string 14",
    "pager": "sample string 15",
    "primary": "sample string 16",
    "telex": "sample string 17",
    "tt_dd": "sample string 18",
    "business_3": "sample string 19",
    "business_4": "sample string 20"
  },
  "customerservice": {
    "relationship_manager": {
      "value": "sample string 1",
      "id": 2
    },
    "customer_service_group": {
      "value": "sample string 1",
      "id": 2
    },
    "introduced_by": {
      "value": "sample string 1",
      "id": 2
    },
    "cust_remarks": "sample string 1",
    "acquired_reason": {
      "value": "sample string 1",
      "id": 2
    },
    "lost_reason": {
      "value": "sample string 1",
      "id": 2
    },
    "relationship_start_date": "sample string 2",
    "sales_channel1": 3,
    "sales_channel2": 4,
    "sales_channel3": 5,
    "sales_channel4": 6,
    "sales_channel5": 7,
    "reference_id": "sample string 8"
  },
  "internal_use": {
    "supress_reg_reporting": "sample string 1",
    "allow_to_transact": true,
    "compliance_status": {
      "value": "sample string 1",
      "id": 2
    },
    "remarks": "sample string 3",
    "audit_date": "sample string 4",
    "entity_lei": "sample string 5",
    "lei_expiry_date": "sample string 6"
  },
  "corporate_profile": {
    "org_jurisdication_id": {
      "value": "sample string 1",
      "id": 2
    },
    "org_structure_id": {
      "value": "sample string 1",
      "id": 2
    },
    "nature_of_buss_id": {
      "value": "sample string 1",
      "id": 2
    },
    "legal_name": "sample string 1",
    "trade_name": "sample string 2",
    "acquisition_details": "sample string 3",
    "corp_acquisition_method_id": {
      "value": "sample string 1",
      "id": 2
    },
    "nature_of_buss_desc": "sample string 4",
    "is_third_party": true,
    "is_on_site_visit": true,
    "incorporation_date": "sample string 7",
    "corp_purpose_of_relationship": {
      "value": "sample string 1",
      "id": 2
    },
    "corp_nature_of_relationship": {
      "value": "sample string 1",
      "id": 2
    }
  },
  "individual_profile": {
    "employer_name": "sample string 1",
    "employee_since": "sample string 2",
    "position": "sample string 3",
    "occupation": "sample string 4",
    "date_of_birth": "sample string 5",
    "is_face_to_face": true,
    "indv_acquisition_method_id": {
      "value": "sample string 1",
      "id": 2
    },
    "acquisition_details": "sample string 7",
    "indv_purpose_of_relationship": {
      "value": "sample string 1",
      "id": 2
    },
    "indv_nature_of_relationship": {
      "value": "sample string 1",
      "id": 2
    },
    "is_third_party": true
  },
  "indv_address": {
    "city": "sample string 1",
    "province": "sample string 2",
    "other": "sample string 3",
    "country": {
      "value": "sample string 1",
      "id": 2
    },
    "postcode": "sample string 4",
    "streetaddress": "sample string 5",
    "addresstype": 6
  },
  "flex_field": {
    "fieldvalue": "sample string 1",
    "fieldname": "sample string 2"
  }
}

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

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.

Response Information

Resource Description

DSOutput

Name	Type	Additional information
status	boolean	None.
data	Object	None.
code	integer	None.
message	string	None.
error	Error	None.
paging	Paging	None.
additional_codes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": true,
  "data": {},
  "code": 0,
  "message": "sample string 3",
  "error": {
    "code": 0,
    "message": "sample string 1",
    "target": "sample string 2",
    "details": [
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      },
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      }
    ]
  },
  "paging": {
    "page_number": 1,
    "page_size": 2,
    "page_from": 3,
    "page_to": 4,
    "record_count": 5
  },
  "additional_codes": "sample string 4"
}

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.