# 企业地址 API

# 查询企业地址编码

接口地址:/api/open/v2/enterprise/address/area/query

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	code	query	true	string

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«AreaDto»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«AreaDto»	ListPagingResponseData«AreaDto»
length		integer(int32)
list		array	AreaDto
children	子项目	array	AreaDto
code	编码	string
name	名称	string
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"children": [
					{
						"code": "",
						"name": ""
					}
				],
				"code": "",
				"name": ""
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 创建企业地址

接口地址:/api/open/v2/enterprise/address/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "cityCode": 0,
    "code": "",
    "contacts": "",
    "countryCode": "",
    "detail": "",
    "districtCode": 0,
    "enterpriseCode": "",
    "enterpriseType": "",
    "fax": "",
    "mobile": "",
    "phone": "",
    "provinceCode": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«EnterpriseAddressSaveParams»	RequestParameter«EnterpriseAddressSaveParams»
body			false	EnterpriseAddressSaveParams	EnterpriseAddressSaveParams
cityCode	地/市		false	integer
code	地址标签		true	string
contacts	联系人		false	string
countryCode	国家编码		false	string
detail	详细地址		false	string
districtCode	区/县		false	integer
enterpriseCode	企业编码		true	string
enterpriseType	企业类型,可用值:CUSTOMER,SUPPLIER		true	string
fax	传真		false	string
mobile	手机号码		false	string
phone	固定电话		false	string
provinceCode	省/直辖市/自治区		false	integer

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除企业地址

接口地址:/api/open/v2/enterprise/address/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

参数是编码

请求示例:

{
  "body": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	code	body	false	RequestParameter«string»	RequestParameter«string»
body			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询企业地址

接口地址:/api/open/v2/enterprise/address/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "codeLike": "",
    "name": "",
    "nameLike": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryParamRequestParameter	queryParamRequestParameter	body	true	RequestParameter«CustomerQueryParam»	RequestParameter«CustomerQueryParam»
body			false	CustomerQueryParam	CustomerQueryParam
code	编码完全匹配		false	string
codeLike	编码模糊匹配		false	string
name	名称完全匹配		false	string
nameLike	名称模糊匹配		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«EnterpriseAddressDTO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«EnterpriseAddressDTO»	ListPagingResponseData«EnterpriseAddressDTO»
length		integer(int32)
list		array	EnterpriseAddressDTO
city	地/市	string
cityCode	地/市	integer
code	编码完全匹配	string
contacts	联系人	string
countryCode	国家编码	string
detail	详细地址	string
district	区/县	string
districtCode	区/县	integer
fax	传真	string
mobile	手机号码	string
phone	固定电话	string
province	省/直辖市/自治区	string
provinceCode	省/直辖市/自治区	integer
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"city": "",
				"cityCode": 0,
				"code": "",
				"contacts": "",
				"countryCode": "",
				"detail": "",
				"district": "",
				"districtCode": 0,
				"fax": "",
				"mobile": "",
				"phone": "",
				"province": "",
				"provinceCode": 0
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改企业地址

接口地址:/api/open/v2/enterprise/address/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "cityCode": 0,
    "code": "",
    "contacts": "",
    "countryCode": "",
    "detail": "",
    "districtCode": 0,
    "enterpriseCode": "",
    "enterpriseType": "",
    "fax": "",
    "mobile": "",
    "phone": "",
    "provinceCode": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«EnterpriseAddressSaveParams»	RequestParameter«EnterpriseAddressSaveParams»
body			false	EnterpriseAddressSaveParams	EnterpriseAddressSaveParams
cityCode	地/市		false	integer
code	地址标签		true	string
contacts	联系人		false	string
countryCode	国家编码		false	string
detail	详细地址		false	string
districtCode	区/县		false	integer
enterpriseCode	企业编码		true	string
enterpriseType	企业类型,可用值:CUSTOMER,SUPPLIER		true	string
fax	传真		false	string
mobile	手机号码		false	string
phone	固定电话		false	string
provinceCode	省/直辖市/自治区		false	integer

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

← 部门API 仓库API →