4. Icons

GET /api/v1/providers/{providerId(qrcodeId)}

• 用途: 取得對方之詳細資料
• header:
  • apiKey(必要的)- API 鑰匙
• payload:

    {}

• parameter:
  • 無
• response: 200 OK

{
  "name": "SDD",
  "avatarId": "cc000484-0d93-40da-8f86-e8fbe5d0049a",
  "profile": "XXXX",
  "location": "XXX",
  "company": "XXX",
  "customerName": "Henry",
  "customerPhoneNum": "+886975531859",
  "customerCompany": "XXXX",
  "customerLocation": "XXXX",
  "state": "enabled",
  "type": "special"
}

404 provider not found

POST /api/v1/icons/

• 用途：增加 icon
• header:
  • apiKey(必要的)- API 鑰匙
• payload:

    {
      "providerUuid": "ecsx-1030-3454-edxf"(QrcodeId), 
      "customer":{
        "name": "Henry",
        "phoneNumber": "0975531859"
        "location":"tw"
        "company":"NTHU"
        "availableStartTime":"00:00"(UTC)
        "availableEndTime":"23:59" (UTC)
        "isEnable":"true"
      }
    }

• response:
  • status
  • 201 created

    { 
      "iconId":"icon-uuid"
    }

POST /api/v1/icons/{icon-id}/calls

• 用途：客戶點下 icon 開啟網頁打電話
• payload: 無
• response:
  • status:
    • 200 OK
    • 404 icon not found

PUT /api/v1/icons/{icon-id}

• 用途：客戶修改相關資料
• payload:

    {
       "name": "Henry",
       "phoneNumber": "0975531859"
       "location":"tw"
        "company":"NTHU"
        "availableStartTime":"00:00"(UTC)
        "availableEndTime":"23:59" (UTC)
        "isEnable":"true"
     }

• response
  • status:
    • 200 OK
    • 404 無該icon

GET /api/v1/icons/{icon-id}

retrieve icon info

• response:
  • 200 OK:info
  • 404

{
  provider:{
    uuid:"wtf",
    userName:"",
    phoneNumber:"string",
    location:"string",
    profile:"string",
    company:"string",
    profilePhotoId:"string",
    qrCodeUuid:"string",
    availableStartTime:"string",
    availableEndTime:"string"
  },
  name:"string",
  phoneNumber:"string",
  location:"string",
  company:"string",
  availableStartTime:"string",
  availableEndTime:"string",
  isEnable:true,
  iconId:"string",
  isTargetEnable: true
}