查询所有加盟商

请求参数

Query 参数

version

string

必需

示例值:

1

Header 参数

Authorization

string

必需

示例值:

Content-Type

string

可选

示例值:

application/json

ent

string

可选

默认值:

Body 参数application/json

organizeId

number

区域id

可选

franchiseeName

string

可选

加盟商名称|限定长度20

phone

string

可选

手机号|限定长度11

idCard

string

可选

身份证|限定长度18

address

string

可选

详细地址|限定长度100

startDate

string

可选

加盟开始日期|YYYY-MM-DD

endDate

string

可选

加盟结束日期|YYYY-MM-DD

notOrganize

integer

可选

无门店的加盟商（notOrganize=1表示无门店的加盟商）

pageNumber

integer

当前页码

必需

pageSize

integer

页码容量

必需

示例

{
    "idCard": "",
    "notOrganize": null,
    "franchiseeName": "",
    "startDate": "",
    "phone": "",
    "endDate": "",
    "organizeId": "",
    "address": "",
    "pageNumber": 200,
    "pageSize": 10
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST '/{{route}}/md/open/franchisee/list?version=1&version=' \
--header 'Authorization: {{Authorization}}' \
--header 'ent: {{ent}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idCard": "",
    "notOrganize": null,
    "franchiseeName": "",
    "startDate": "",
    "phone": "",
    "endDate": "",
    "organizeId": "",
    "address": "",
    "pageNumber": 200,
    "pageSize": 10
}'

返回响应

🟢200名字查询加盟商

application/json

Body

status

integer

必需

状态（0表示成功，其他则为错误）

message

string

可选

消息（成功或失败时的消息提示）

data

array [object {8}]

必需

franchiseeId

number

加盟商id

必需

franchiseeCode

string

加盟商编号

必需

franchiseeName

string

加盟商名称

必需

phone

string | null

手机号

必需

idCard

string | null

身份证

必需

address

string | null

详细地址

必需

startDate

string | null

加盟日期

必需

countStore

integer

必需

门店数（为数字，无门店则为0）

totalRow

number

总数

必需

pageNumber

number

当前页码

必需

totalPage

number

总页数

必需

isLastPage

boolean

是否是最后一页

必需

pageSize

number

页面容量

必需

isFirstPage

boolean

是否是第一页

必需

示例

{
    "totalRow": 1,
    "pageNumber": 1,
    "data": [
        {
            "address": "",
            "franchiseeCode": "902760",
            "phone": "12345678901",
            "franchiseeName": "加盟_blue",
            "idCard": "",
            "created": "2022-06-29 20:29:57",
            "countStore": 2,
            "franchiseeId": 10000000000024,
            "startDate": null
        }
    ],
    "totalPage": 1,
    "isLastPage": true,
    "pageSize": 10,
    "isFirstPage": true,
    "status": 0
}