smoa_web/data/docs.json

{
  "code": 200,
  "data": {
    "property": {
      "Emergency": [
        {
          "key": "name",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "phone",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "address",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        }
      ],
      "Employer": [
        {
          "key": "employer",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "phone",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "position",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "inCharge",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "howLong",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "annualIncode",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        }
      ],
      "PresentLivingInfomation": [
        {
          "key": "address",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "landlord",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "type",
          "title": "rent or own",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "howLong",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "typeOfPet",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "phone",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        }
      ],
      "PropertyMeta": [
        {
          "key": "companyName",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "paymentDay",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "contact",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "phone",
          "title": "",
          "type": "string",
          "required": "",
          "default": ""
        },
        {
          "key": "monthFee",
          "title": "",
          "type": "uint32",
          "required": "",
          "default": ""
        },
        {
          "key": "payType",
          "title": "1-monthly 2-annual 3-monthly_percent_of_rent 4 annual_percent_of_rent",
          "type": "uint32",
          "required": "",
          "default": ""
        },
        {
          "key": "service",
          "title": "",
          "type": "[]string",
          "required": "",
          "default": ""
        }
      ]
    },
    "router": [
      { "action": "user.info", "title": "", "Params": [] },
      {
        "action": "auth.forgot",
        "title": "密码重置",
        "Params": [
          {
            "key": "mail",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          }
        ]
      },
      {
        "action": "auth.resetpass",
        "title": "密码重置",
        "Params": [
          {
            "key": "code",
            "title": "校验码",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "email",
            "title": "邮件地址",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "password",
            "title": "新的密码",
            "type": "string",
            "required": "required",
            "default": ""
          }
        ]
      },
      {
        "action": "auth.signin",
        "title": "用户登入",
        "Params": [
          {
            "key": "email",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "password",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          }
        ]
      },
      {
        "action": "auth.signup",
        "title": "用户注册",
        "Params": [
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "email",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "password",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          }
        ]
      },
      {
        "action": "property.detail",
        "title": "property detail",
        "Params": [
          {
            "key": "propertyId",
            "title": "",
            "type": "int",
            "required": "required",
            "default": ""
          }
        ]
      },
      {
        "action": "property.list",
        "title": "property list",
        "Params": [
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "status",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "property.new",
        "title": "New or update property",
        "Params": [
          {
            "key": "id",
            "title": "0-new other-update",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "unit",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "street",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "city",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "province",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "postalCode",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "pics",
            "title": "",
            "type": "[]string",
            "required": "",
            "default": ""
          },
          {
            "key": "bedrooms",
            "title": "",
            "type": "uint8",
            "required": "",
            "default": ""
          },
          {
            "key": "bathrooms",
            "title": "",
            "type": "uint8",
            "required": "",
            "default": ""
          },
          {
            "key": "parkings",
            "title": "",
            "type": "uint8",
            "required": "",
            "default": ""
          },
          {
            "key": "propertyType",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "allowPet",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "buildingArea",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "yearBuilt",
            "title": "",
            "type": "int",
            "required": "required",
            "default": ""
          },
          {
            "key": "yearTax",
            "title": "",
            "type": "int",
            "required": "required",
            "default": ""
          },
          {
            "key": "expectedRent",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "electricity",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "wifi",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "water",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "gas",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "facility",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "inroduction",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "insurance",
            "title": "",
            "type": "PropertyMeta",
            "required": "",
            "default": ""
          },
          {
            "key": "strata",
            "title": "",
            "type": "PropertyMeta",
            "required": "",
            "default": ""
          },
          {
            "key": "management",
            "title": "",
            "type": "PropertyMeta",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "technician.addfile",
        "title": "technician 增加文件资料",
        "Params": [
          {
            "key": "technicianId",
            "title": "技工的id",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "fileType",
            "title": "文件类型 contract application dirverLicense voidCheck",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "fileUrl",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "technician.addnote",
        "title": "给技工写评价",
        "Params": [
          {
            "key": "technicianId",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "content",
            "title": "评价内容",
            "type": "int",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "technician.detail",
        "title": "tanant 详情",
        "Params": [
          {
            "key": "technicianId",
            "title": "租客的id",
            "type": "int",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "technician.list",
        "title": "技工的列表",
        "Params": [
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "skill",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "technician.new",
        "title": "technician 新增或修改",
        "Params": [
          {
            "key": "technicianId",
            "title": "0-new other-update",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "cell",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "email",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "address",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "skills",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "serviceArea",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "labor",
            "title": "每小时的费用",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "website",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "inroduction",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "landlord.addfile",
        "title": "landlord 编辑文件",
        "Params": [
          {
            "key": "landlordId",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "fileType",
            "title": "delegateContract,voidCheck,insurance,other",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "url",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "landlord.addnote",
        "title": "给房东写评价",
        "Params": [
          {
            "key": "landlordId",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "content",
            "title": "评价内容",
            "type": "int",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "landlord.detail",
        "title": "landlord 详细信息",
        "Params": [
          {
            "key": "landlordId",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "landlord.list",
        "title": "landlord list",
        "Params": [
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "status",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "landlord.new",
        "title": "landlord 新增或修改",
        "Params": [
          {
            "key": "landlordId",
            "title": "0-new other-update",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "nationality",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "birthday",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "phone",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "cell",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "email",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "address",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "delegateContract",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "voidCheck",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "insurance",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "other",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "tenant.addfile",
        "title": "tanant 增加文件资料",
        "Params": [
          {
            "key": "tanentId",
            "title": "租客的id",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "fileType",
            "title": "文件类型 contract application dirverLicense voidCheck",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "fileUrl",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "tenant.addnote",
        "title": "给技工写评价",
        "Params": [
          {
            "key": "technicianId",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "content",
            "title": "评价内容",
            "type": "int",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "tenant.application",
        "title": "申请租户",
        "Params": [
          {
            "key": "propertyId",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "phone",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "cell",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "email",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "birthday",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "marital",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "socialInsuranceNo",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "dirverLicenseNo",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "bankName",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "branchAddress",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "emergencyContact",
            "title": "",
            "type": "[]Emergency",
            "required": "",
            "default": ""
          },
          {
            "key": "presentLivingInfomation",
            "title": "employer information",
            "type": "PresentLivingInfomation",
            "required": "",
            "default": ""
          },
          {
            "key": "employerInformation",
            "title": "employer information",
            "type": "Employer",
            "required": "",
            "default": ""
          },
          {
            "key": "rentalAddress",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "tenant.detail",
        "title": "tanant 详情",
        "Params": [
          {
            "key": "tanentId",
            "title": "租客的id",
            "type": "int",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "tenant.list",
        "title": "tenant list",
        "Params": [
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "status",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "tenant.new",
        "title": "tenant 新增或修改",
        "Params": [
          {
            "key": "tanentId",
            "title": "0-new other-update",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "name",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "phone",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "cell",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "email",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "birthday",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "marital",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "socialInsuranceNo",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "dirverLicenseNo",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "bankName",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "branchAddress",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "firstEmergency",
            "title": "",
            "type": "Emergency",
            "required": "",
            "default": ""
          },
          {
            "key": "nextEmergency",
            "title": "",
            "type": "Emergency",
            "required": "",
            "default": ""
          },
          {
            "key": "employer",
            "title": "employer information",
            "type": "Employer",
            "required": "",
            "default": ""
          },
          {
            "key": "monthlyRent",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "securityDeposite",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "moveInDate",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "moveOutDate",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "leaseType",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "collectFrequency",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "regularVisit",
            "title": "",
            "type": "int",
            "required": "",
            "default": ""
          },
          {
            "key": "rentalAddress",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.applicationinfo",
        "title": "推广详情",
        "Params": [
          {
            "key": "id",
            "title": "",
            "type": "uint",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.applicationlist",
        "title": "申请列表",
        "Params": [
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.inspectioninfo",
        "title": "检查详情",
        "Params": [
          {
            "key": "id",
            "title": "",
            "type": "uint",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.inspectionlist",
        "title": "检查列表",
        "Params": [
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.marketinginfo",
        "title": "推广详情",
        "Params": [
          {
            "key": "id",
            "title": "",
            "type": "uint",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.marketinglist",
        "title": "推广列表",
        "Params": [
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.notification",
        "title": "send routine notification",
        "Params": [
          {
            "key": "type",
            "title": "",
            "type": "string",
            "required": "required",
            "default": ""
          },
          {
            "key": "unit",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "date",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "fromId",
            "title": "",
            "type": "int32",
            "required": "",
            "default": ""
          },
          {
            "key": "toId",
            "title": "",
            "type": "int32",
            "required": "",
            "default": ""
          },
          {
            "key": "fromName",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "toName",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          },
          {
            "key": "files",
            "title": "",
            "type": "[]string",
            "required": "",
            "default": ""
          },
          {
            "key": "description",
            "title": "",
            "type": "string",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.paymentinfo",
        "title": "付款详情",
        "Params": [
          {
            "key": "id",
            "title": "",
            "type": "uint",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.paymentlist",
        "title": "付款列表",
        "Params": [
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.repairinfo",
        "title": "维修详情",
        "Params": [
          {
            "key": "id",
            "title": "",
            "type": "uint",
            "required": "",
            "default": ""
          }
        ]
      },
      {
        "action": "routine.repairlist",
        "title": "维修列表",
        "Params": [
          {
            "key": "from",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          },
          {
            "key": "size",
            "title": "",
            "type": "uint32",
            "required": "",
            "default": ""
          }
        ]
      },
      { "action": "dashboard.mybusiness", "title": "统计数据", "Params": [] }
    ]
  }
}