Get Single FGate

  • Description

    This interface is to retrieve all FGate groups of current user's account, along with the parameters of FGates under each group.

  • Request Address

    URL：[Host Server]/api/client/box/reg/boxno/{boxNo}

  • Address Parameter Description

    Field Type Description
    Host Server string See Explanation of terms
    boxNo string Serial number of FGate

  • Method

    GET

  • Headers

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

  • Body

    NULL

  • Success Response

    Note: The interface returns many parameters, the parameters listed in the document are basically required parameters, other parameters are not written in the document is not used parameters, please ignore.

    Response Fields

    Field Type Description
    id string Registration ID associated with the user when adding (sharing) the FGate
    boxUid string FGate ID
    alias string FGate alias
    regData string Registration date
    owned boolean Whether owned by the user
    shared boolean Whether shared by others
    box json object See table below
    group json object Group to which the FGate belongs
    group_Id string Group ID
    user json object Information of the account to which the FGate belongs
    user_Id string User ID

    box Object Properties

    Field Type Description
    id string FGate UID
    boxNo string FGate serial number
    boxType string 0: Standard Box, 1: Mini Box, 2, 4, 7: Lite Box, 5: Link Box
    connectionState int
    cs JSON object apiBaseUrl: Server which box is connected with.
    signalrUrl: SignalR server which box pushes data to.
    devicePrimarySource int FGate data source, 0: FGate, 1: Server
    memo string Remark
    net int 0: Unknown, 1: Ethernet, 2: GPRS, 4: WIFI (not supported), 5: 4G
    mode int 1: Transparent, 0: Normal
    useLongitude double Longitude of manual positioning
    useLatitude double Latitude of manual positioning
    longitude double Longitude of automatical positioning
    latitude double Latitude of automatical positioning
    useAddress string Location of manual positioning
    address string Location of automatical positioning
    radius int Longitude radius

    group Object Properties

    Field Type Description
    id string Group ID
    name string Name of the group

    user Object Properties

    Field Type Description
    userName string Name of the user
    email string User's email
    phoneNumber string User's phone number

  • Status Codes

    Code Description
    401 Access token expired
    404 FGate does not exist