• HTTP document
    Show / Hide Table of Contents
    • Login Interface
      • Explanation of terms
      • Login
      • Refresh Login
    • Write Data Process
      • Add FGate Group
      • Add FGate
      • Add Monitoring Group
      • Add Monitoring Point
      • Get FGate List
      • FGate Monitoring List
      • Write Monitoring Value
      • Get Monitoring Value
    • Information Access
      • Get Single FGate
      • Get Monitoring Group
      • Get Some monitoring Points
      • Get Monitoring Point by Group
      • Get Iccid、Imei
      • Get Location of FGate
    • Remote Download
      • Get FGate Drive List
      • Download FGate Drive
      • Get Register Type of Device
      • Get Server Drive List
    • Modification Interface
      • Modify FGate Group
      • Modify FGate Name
      • Modify Monitoring
      • Modify Refresh Interval
    • Delete Interface
      • Delete FGate Group
      • Delete FGate
      • Delete Monitoring Group
      • Delete Monitoring Point
    • Alarm Interface
      • Alarm Group
        • Get Alarm Group List
        • Add Alarm Group
        • Modify Alarm Group
        • Delete Alarm Group
      • Alarm Contact
        • Get Alarm Contact List
        • Get Single Alarm Contact
        • Add Alarm contact
        • Modify Alarm Contact
        • Delete Alarm Contact
      • Alarm Record
        • Get Alarm Entry List
        • Get Alarm Entry
        • Add Alarm Entry
        • Modify Alarm Entry
        • Delete Alarm Entry
        • Get Historical Alarm
        • Get Alarm Entry Status
        • Confirm Alarm
    • Historical Data
      • Get Historical Data List
      • Get Historical Data Entry
      • Add Historical Record
      • Update Historical Record
      • Delete Historical Data
      • Get Historical Data
    • Push Monitoring Data
      • Enable Monitoring Group
      • Disable Monitoring Group
      • Enable Monitoring Group List
      • Disable Monitoring Group List
      • Enable All Monitoring Points
      • Disable All Monitoring Points
      • Enable One Monitoring Point
      • Disable One Monitoring Point
      • Enable Some Monitoring Points
      • Disable Some Monitoring Points
      • Enable Some Monitoring Points
      • Enable One Monitoring Group
      • Enable Some Monitoring Groups
    • Data Push(SignalR)
      • Real-time Data Push(signalR)
      • Status Change Push
      • Real-time Data Push
      • Alarm Trigger
      • Alarm Restore
    • Write in Batch
      • Get Bacth Write Group
      • Write Value in Batch
    • Appendix
      • Appendix One
      • Appendix Two
      • Appendix Three
      • 429 Status Code

    Add FGate

    • Description

      This functionality is used for users to add FGates.

      Note:
      Can only be added by the owner. An FGate can only have one owner at a time

    • Request URL (Choose one)

      URL1:[Host Server]/api/client/box/reg

      URL2:[Host Server]/api/client/v2/box/register

    • Query Parameters

      Field Type Description
      Host Server string See Explanation of terms
    • Method

      POST

    • Headers

      Field Type Description
      Authorization string "Bearer " + Access Token obtained from the login interface
    • Body

      Field Type Description
      alias string FGate Alias
      boxNo string FGate Serial No
      boxPassword string FGate Password
      groupId string FGate group UID or Group Name, choose one
      groupName string FGate group UID or Group Name, choose one. If it does not exist, a new group will be created
    • Successful Response

      Return FGate's regId (return as string, not in JSON format).

    • Return Code

      Field Description
      304 The FGate has already been added.
      401 Access Token Expired
      404 The FGate does not exist.
      406 The FGate has already been added by someone else.
      403 FGate's password is incorrect.
      414 The FGate serial number is not valid.
      417 FGate is in your device list.
    • Please see the example in the following image.

    Login Interface

    Back to top Generated by DocFX