Skip to content

Latest commit

 

History

History
433 lines (369 loc) · 10.3 KB

api_description.md

File metadata and controls

433 lines (369 loc) · 10.3 KB

api/login

Method API for check login params and get user level

request params:
  • login
  • password
  • responce
    success:
  • status ( 'ok' )
  • user_role
  • 2 = 'staff'; 3 = 'relative'; 4 = 'patient'
  • result ('valid')
  • user_type
  • user_id
  • authToken
  • error:
  • result ('error')
  • error_message
  • error
  • app/login_bankid

    request GET
    params:
  • grandidsession
  • responce:
    json responce from bank_id API

    api/get_patients_list()

    Method API for select patients list for Staff or Relative

    request GET
    params:
  • authToken
  • user_id responce:
  • status ( 'ok' )
  • provider_id
  • first_name
  • last_name"
  • phone
  • email
  • photo
  • lang
  • patients ([user_id]=>[$patient_info["patient_id" "provider_id" "first_name" "last_name" "phone" "email" "address" "city" "photo" "lang"])
  • patients_num
  • api/get_personal_push_list

    Method API for select personal notification for users

    request POST
  • authToken
  • user_id
  • patient_id
  • responce
  • ["mess_list"][ $num ]["push_title"]
  • ["mess_list"][ $num ]["push_type"]
  • ["mess_list"][ $num ]["created_time"]
  • ["mess_list"][ $num ]["pid"]

    api/get_provider_info

    Load generall info about Provider

    request POST
  • 'authToken'
  • 'provider_id'
    reaponce
  • "provider_title"
  • "provider_logo"
  • "provider_menu_logo"
  • "color_model"
  • "provider_info"
  • "currency"
  • "stripe_currency"
  • "currency_place"
  • api/get_pages

    request POST
    param: page_name
    responce
  • title
  • page_info
  • sub_links

    api/get_homepage_items

    Select all Homepage items for this Provider

    request POST
    param:
  • 'authToken'
  • 'provider_id'
    responce
  • status
  • ["menu_items"][ $num ]["menu_title"]
  • ["menu_items"][ $num ]["menu_icon"]
  • ["menu_items"][ $num ]["menu_link"]
  • ["menu_items"][ $num ]["menu_type"]
  • ["menu_items"][ $num ]["level"]

    api/get_documents

    Get documents List and Single view

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'task'
  • 'doc_type'
  • 'item_id'
  • 'patient_id'
  • responce
    status
  • item_date
  • item_title
  • image
  • item_content
  • item_header
  • pdf_link
  • api/get_products_list

    Get page Product List

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'parent_page'
  • responce
  • ["menu_items"][ $num ]["menu_title"]
  • ["menu_items"][ $num ]["menu_icon"]
  • ["menu_items"][ $num ]["menu_link"]
  • ["menu_items"][ $num ]["sort_id"]
  • ["menu_items"][ $num ]["menu_type"]
  • ["menu_items"][ $num ]["level"]
  • "title"
  • "page_desc"

    api/get_product

    Get page Product Details

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'page_link'
  • responce
  • "product_title"
  • "product_desc"
  • "sort_id"
  • ["items"][ $'prod_item_id' ]["title"]
  • ["items"][ $'prod_item_id' ]["description"]
  • ["items"][ $'prod_item_id' ]["price"]
  • ["items"][ $'prod_item_id' ]["mandatory"]
  • ["items"][ $'prod_item_id' ]["item_id"]
  • ["items"][ $'prod_item_id' ]["item_type"];
  • ["items"][ $'prod_item_id' ]["choices"][ $row3['id'] ]["title"]
  • ["items"][ $'prod_item_id' ]["choices"][ $row3['id'] ]["description"]
  • ["items"][ $'prod_item_id' ]["choices"][ $row3['id'] ]["prod_item_id"]

    api/save_order

    Save Patients Order

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'patient_id'
  • 'page_link'
  • 'order_title'
  • 'order_data'
  • 'price'
  • 'currency'
  • responce
  • "status" = 'ok'
    or
  • "error" = $error;

    api/get_orders_history

    Get Orders History for this Patient

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'patient_id'
  • responce
  • "status" = 'ok'
  • ['orders'][ $num ]["order_title"]
  • ['orders'][ $num ]["price"]
  • ['orders'][ $num ]["order_status"]
  • ['orders'][ $num ]["create_date"]
  • ['orders'][ $num ]["selected_items"]

    api/get_food_menu

    Get Food Menu Items

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'page_link'
  • responce
  • "status"] = 'ok'
  • "product_title"]
  • "product_desc"
  • "visit_date"
  • "from_date"
  • "to_date"
  • "price"
  • "comment"
  • "icon"
  • "sort_id"
  • "food_menu"
  • api/load_patient

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'patient_id'
  • responce
  • "status" = 'ok'
  • [patient_info]["patient_id"]
  • [patient_info]["provider_id"]
  • [patient_info]["first_name"]
  • [patient_info]["last_name"]
  • [patient_info]["phone"]
  • [patient_info]["email"]
  • [patient_info]["address"]
  • [patient_info]["city"]
  • [patient_info]["photo"]
  • [patient_info]["lang"]

    api/update_profile

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'patient_id'
  • 'first_name'
  • 'last_name'
  • 'address'
  • 'city'
  • 'email'
  • 'phone'
  • 'new_password'
  • 'old_password'
  • responce
  • "status" = 'ok'

    api/get_chat

    request POST
    param:
  • 'authToken'
  • 'user_from'
  • 'user_to'
  • 'user_type'
  • 'last_message_id'
  • responce
  • "status"
  • "updated"]
  • "last_message_id"]
  • "messages"][$num]["id"]
  • "messages"][$num]["messageText"]
  • "messages"][$num]["attachment_url"]
  • "messages"][$num]["user_type"]
  • "messages"][$num]["time"]
  • "messages"][$num]["user_photo"]
  • "messages"][$num]["user_name"]
  • api/send_chat

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'user_to'
  • 'message'
  • 'action'
  • responce
  • "status" = 'ok'
  • "group_id"
  • "updated"

    api/upload_image

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'action'
  • $_FILES['wpua-file']['name'];
    responce
  • "updated" = true

    api/check_app_version

    request POST
    param:
  • 'authToken'
  • responce
  • "status" = 'ok'
  • "app_version"

    api/load_user

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • responce
  • "status" = 'ok'
  • ["user_info"]["patient_id"]
  • ["user_info"]["provider_id"]
  • ["user_info"]["first_name"]
  • ["user_info"]["last_name"]
  • ["user_info"]["phone"]
  • ["user_info"]["email"]
  • ["user_info"]["address"]
  • ["user_info"]["city"]
  • ["user_info"]["photo"]
  • ["user_info"]["lang"]
  • api/stripe_paymen

    request POST
    param:
  • 'authToken'
  • 'user_id'
  • 'token'
  • 'amount'
  • 'currency'
  • 'description'
  • 'action'
  • 'order_id'
  • responce
  • "status" = 'ok'
  • "payment_result"
  • "transaction_id"
  • "card_token"
  • api/cancel_order

    request POST
    param:
  • 'order_id'
    responce
  • "status" = 'ok'

    api/login_bank_id

    request GET
  • ' personNumber'
  • 'sessionId'
    responce
  • redirectURL
  • sessionID

    api/check_if_can_order

    request GET
  • user_id
  • product_id
  • patient_id
    responce
  • "status" = 'ok'
  • can_order = true/false

    api/get_user_modules

    request POST
  • user_id
    responce
  • "status" = 'ok'
  • modules = array of modules

    api/log_log_out

    request GET
  • user_id
    responce
  • "status" = 'ok'