내원객 정보 검색

POST 
/visitor/open/v1/queries/search-visitors

조건에 맞는 내원객 정보를 검색합니다.

Request

### Content-Type별 요청의 JSON Schema

{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "type": "integer",
          "format": "int32"
        },
        "partOfVisitorName": {
          "type": "string"
        },
        "dateOfBirth": {
          "type": "string",
          "description": "`yyyy-MM-dd 00:00:00.000'Z'` 형태의 ISO 8601 포맷을 전달해야 함"
        },
        "chartNumber": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "phone": {
          "allOf": [
            {
              "required": [
                "countryCode",
                "phoneNumber"
              ],
              "type": "object",
              "properties": {
                "countryCode": {
                  "type": "string",
                  "description": "국제전화 국가 번호n 예: 82, 81, 1, 44 ... [참고](https://ko.wikipedia.org/wiki/%EA%B5%AD%EC%A0%9C%EC%A0%84%ED%99%94_%EA%B5%AD%EA%B0%80_%EB%B2%88%ED%98%B8)"
                },
                "phoneNumber": {
                  "type": "string",
                  "description": "전화번호n 예: 10123456789"
                }
              },
              "title": "protos.Phone"
            }
          ],
          "description": "ex)n { "countryCode": "82", "phoneNumber": "1000000000" }"
        }
      },
      "title": "protos.open.SearchVisitors"
    }
  }
}

Responses

200

OK

### Status Code별 응답의 JSON Schema

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "chartNumber": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "phoneNumber": {
                    "required": [
                      "countryCode",
                      "phoneNumber"
                    ],
                    "type": "object",
                    "properties": {
                      "countryCode": {
                        "type": "string",
                        "description": "국제전화 국가 번호n 예: 82, 81, 1, 44 ... [참고](https://ko.wikipedia.org/wiki/%EA%B5%AD%EC%A0%9C%EC%A0%84%ED%99%94_%EA%B5%AD%EA%B0%80_%EB%B2%88%ED%98%B8)"
                      },
                      "phoneNumber": {
                        "type": "string",
                        "description": "전화번호n 예: 10123456789"
                      }
                    },
                    "title": "protos.Phone"
                  },
                  "dateOfBirth": {
                    "type": "string"
                  },
                  "gender": {
                    "enum": [
                      "GENDER_UNSPECIFIED",
                      "MALE",
                      "FEMALE"
                    ],
                    "type": "string",
                    "format": "enum"
                  },
                  "nationality": {
                    "type": "string"
                  },
                  "additionalPhoneNumber": {
                    "required": [
                      "countryCode",
                      "phoneNumber"
                    ],
                    "type": "object",
                    "properties": {
                      "countryCode": {
                        "type": "string",
                        "description": "국제전화 국가 번호n 예: 82, 81, 1, 44 ... [참고](https://ko.wikipedia.org/wiki/%EA%B5%AD%EC%A0%9C%EC%A0%84%ED%99%94_%EA%B5%AD%EA%B0%80_%EB%B2%88%ED%98%B8)"
                      },
                      "phoneNumber": {
                        "type": "string",
                        "description": "전화번호n 예: 10123456789"
                      }
                    },
                    "title": "protos.Phone"
                  },
                  "passportSurname": {
                    "type": "string"
                  },
                  "passportGivenNames": {
                    "type": "string"
                  }
                },
                "title": "protos.open.VisitorInformation"
              }
            }
          },
          "title": "protos.open.SearchVisitorsResponse"
        }
      }
    }
  }
}