📄DetailedDocs

API 추가 설명

Image Detail

  • POST https://service-stage.pic-origin.com/api/v1/users/{user_id}/images

    1. Image.folder_id, folder.parent_id = None : root folder에 위치함을 의미

    2. has_det : [True, False, None]

      1. True : 상세주소 입력됨

      2. False : 상세주소 없음(필요x)

      3. None: 상세주소 미입력

  • GET https://service-stage.pic-origin.com/api/v1/users/{user_id}/images

    1. with_history : image 리스폰스의 filedatas 유무

    2. has_delete_at : 휴지통 여부 (image의 삭제(soft delete)의 기준은 delete_at의 유무)

      1. True: 휴지통만 조회

      2. False: 휴지통 아닌 것만 조회

      3. 모두 조회

    3. download : view_type 이 list일 경우 필요한 이미지 다운로드를 위한 쿼리

      1. has_det, date 는 download 를 위한 쿼리 파라미터

    4. latitude, longitude : view_type이 map일 경우 필요한 위도, 경도

    5. has_det : [True, False, None]

      1. True : 상세주소 입력됨

      2. False : 상세주소 없음(필요x)

      3. None: 상세주소 미입력

    6. view_type 활용

      • “view_type” == “map”

        • “latitude” and “longitude” are required

      • “view_type” == “grid”

        • “search_type” is not None

          • “search” is required

        • “days_or_date_range” == “days_range”

          • “days_range” is required

          • “search_date_by” is option

        • “days_or_date_range” == “date_range”

          • “start_date” and “end_date” are required

          • “search_date_by” is option

      • “view_type” == “list”

        • “download” == True

          • “search” and “date” are required

          • “has_delete_at” must not be True

view_type_functions[map](with_history, latitude, longitude, has_delete_at, with_memo, with_custom)
view_type_functions[grid](sort_by, sort_order, with_history, last_index, page_size, search, search_type, has_delete_at, days_or_date_range, days_range, search_date_by, start_date, end_date, with_memo, with_custom)
view_type_functions[list](sort_by, sort_order, with_history, last_index, page_size, search, search_type, has_delete_at, download, has_det, date, with_memo, with_custom)
view_type_functions[grid_sep](sort_by, sort_order, with_history, last_index, page_size, search, search_type, has_delete_at, with_memo, with_custom)

  • PUT https://service-stage.pic-origin.com/api/v1/users/{user_id}/images/{image}

    1. delete : True = 이미지 삭제(soft delete), False = 이미지 복원, None = 이미지 유지

    2. Image.folder_id, folder.parent_id = None : root folder에 위치함을 의미

    3. folder_id

      1. 최상단 폴더로 이동

        • 값: 공백 (" ")

        • 설명: folder_id값을 공백으로 설정하면, 최상단 폴더로 이동

      2. 하위 폴더로 이동

        • 값: 특정 folder_id

        • 설명: folder_id에 특정 폴더의 id를 입력하면, 해당 하위 폴더로 이동

      3. 폴더 이동 없음

        • 값: folder_id파라미터 생략

        • 설명: folder_id파라미터를 요청에 포함하지 않으면, 현재 위치에서 폴더 이동 없이 작업을 수행

Folder Detail

  • GET https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}

    1. Image.folder_id, folder.parent_id = None : root folder에 위치함을 의미

    2. get_image : 이미지를 포함할지 여부

    3. has_delete_at : 휴지통 여부 (image의 삭제(soft delete)의 기준은 delete_at의 유무)

      1. True: 휴지통만 조회

      2. False: 휴지통 아닌 것만 조회

      3. 모두 조회

  • PUT https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}

    1. delete : 이미지 삭제 여부(soft delete)

      1. True = 이미지 삭제

      2. False = 이미지 복원

      3. None = 이미지 유지

    2. Image.folder_id, folder.parent_id = None : root folder에 위치함을 의미

    3. parent_id

      1. 최상단 폴더로 이동

        • 값: 공백 (" ")

        • 설명: parent_id값을 공백으로 설정하면, 최상단 폴더로 이동

      2. 하위 폴더로 이동

        • 값: 특정 parent_id

        • 설명: parent_id에 특정 폴더의 id를 입력하면, 해당 하위 폴더로 이동

      3. 폴더 이동 없음

        • 값: parent_id파라미터 생략

        • 설명: parent_id파라미터를 요청에 포함하지 않으면, 현재 위치에서 폴더 이동 없이 작업을 수행

PreviousImageNextChangeLog

Last updated