Info()

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

Request

No extra data required.

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
{
    "Result": {
        "InstanceSupportKnowledgeBase": <string>,
        "InstanceSupportEmail": <string>,
        "InstanceSupportPhone": <string>,
        "Instance": <string>,
        "InstanceID": <int>,
        "Subscriber": <string>,
        "SubscriberID": <int>,
        "SubscriberTimeOffset": <timezone offset>, // Subscriber's default timezone offset (e.g. -04:30)
        "SubscriberTimeDst": <bool>, // Subscriber's default preference for automatic daylight savings adjustment
        "Styling": {
        "Background": <string>, // Hexadecimal HTML color code of the subscriber's top bar
        "LinkColor": <string>, // Hexadecimal HTML color code of the links on the subscriber's top bar
        "GlyphColor": <string>, // Hexadecimal HTML color code of the logo or icon in the middle of the subscriber's top bar
        "Glyph": <string> // The character(s) that get transformed into the logo or icon in the middle of the subscriber's top bar
        },
        "CustomFieldUnits": [ // User's unit preferences
            {
                "Type": <int>, // Internal ID of the unit type (e.g. Length (short), Volume (medium), etc.)
                "Units": <int>, // Internal ID of the user's preferred unit
                "UpdateOnSelect": <bool> // Whether to update this preference when the user selects units in a form edit
            },
        ... <More unit preferences>
        ],
        "FormulaMeasurementStandard": <bool>, // Whether to normalize measurement fields in formulas to standard (true) or metric (false) units
        "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)
        "DataWarehouse": { // Since RPM31
            "Status": <enum
                1=Starting,
                2=Started,
                3=Finishing,
                4=Finished
            >,
            "StatusTime": <string date+time+tz>, // 2021-10-29T15:17:06+00:00
            "DataAsOf": <string date+time+tz>, // 2021-10-29T15:17:06+00:00
            "Result": <enum
                0=NoErrors, 
                1=StepsHaveErrors,
                2=UserCancelled,
                3=InternalError,
                4=StartFailed,
                5=StopFailed,
                6=UnrecoverableError
            >
        }
    }
}

Notes

  • Available since RPM 14: SubscriberTimeOffset, SubscriberTimeDst, TimeOffset, TimeDst.
  • Available since RPM 16: Styling
  • Available since RPM 17: InstanceSupportKnowledgeBase, InstanceSupportEmail, InstanceSupportPhone
  • Available since RPM 18: CustomFieldUnits, FormulaMeasurementStandard
  • Available since RPM 31: DataWarehouse status information

Errors

No other errors.