Info

Info()

Get the basic Info attached to the API Key being used.

Request

No extra data required.

Response

{
  "Result": {
    "Instance"       : <string>,
    "InstanceID"     : <int>,
    "InstanceContact": <string>,
    "Subscriber"        : <string>,
    "SubscriberID"      : <int>,
    "SubscriberContact" : <string>,
    "SubscriberTimeOffset": <timezone offset>, // Subscriber's default timezone offset (e.g. -04:30) 
    "SubscriberTimeDst": <bool>, // Subscriber's default preference for automatic daylight savings adjustment
    "User"  : <string>,
    "UserID": <int>,
    "TimeOffset": <timezone offset>, // User's preferred timezone offset (e.g. -04:30) 
    "TimeDst": <bool>, // User's preferred automatic daylight savings adjustment
    "Role"  : <string>,
    "TimeFormat": <enum 1=12h, 2=24h> // Display time+date dates using 24 hour format (22:00) or 12 hour format (10:00 PM)
  }
}

Notes

  • Available since RPM 14: SubscriberTimeOffset, SubscriberTimeDst, TimeOffset, TimeDst.

Errors

No other errors.

%d bloggers like this: