user-portal-url |
string |
Provides the URL of a web portal that MUST be accessed over TLS with
which a user can interact. |
venue-info-url |
string |
Provides the URL of a webpage or site that SHOULD be accessed over
TLS on which the operator of the network has information that it wishes
to share with the user (e.g., store info, maps, flight status, or entertainment). |
can-extend-session |
boolean |
Indicates that the URL specified
as "user-portal-url" allows the user to extend a session once the
client is no longer in a state of captivity. This provides a hint that
a client system can suggest accessing the portal URL to the user when
the session is near its limit in terms of time or bytes.
|
seconds-remaining |
number |
An integer that indicates the number
of seconds remaining, after which the client will be placed into a
captive state. The API server SHOULD include this value
if the client is not captive (i.e., captive=false) and the client
session is time-limited and SHOULD omit this value for
captive clients (i.e., captive=true) or when the session is not
time-limited.
|
bytes-remaining |
number |
An integer that indicates the number of bytes remaining, after
which the client will be placed into a captive state. The byte
count represents the sum of the total number of IP packet (layer 3)
bytes sent and received by the client, including IP headers. Captive
Portal systems might not count traffic to whitelisted servers, such as
the API server, but clients cannot rely on such behavior. The API
server SHOULD include this value if the client is not
captive (i.e., captive=false) and the client session is byte-limited
and SHOULD omit this value for captive clients
(i.e., captive=true) or when the session is not byte-limited.
|