Get States¶

Endpoint URL¶

[GET] https://[address]:[port]/rest/ExternalGetStates

Calling The Endpoint¶

Headers

x-api-key - This is the API key from the WCF Connector in Totalview Admin (see more)

Example Calling The Endpoint Via cURL¶

curl --location --request GET 'https://[address]:[port]/rest/ExternalGetStates \
--header 'x-api-key: APIKEY' \
--data-raw ''

Example result

{
    "ExternalGetStatesResult": [
        {
            "Caption": "In",
            "StateColor": {
                "B": 64,
                "G": 128,
                "R": 0
            },
            "StateEndingType": "SameDay",
            "StateID": "In",
            "TextIsRequired": true
        },
        {
            "Caption": "Home",
            "StateColor": {
                "B": 0,
                "G": 0,
                "R": 0
            },
            "StateEndingType": "NoRequired",
            "StateID": "home",
            "TextIsRequired": false
        },
        {
            "Caption": "Busy",
            "StateColor": {
                "B": 255,
                "G": 0,
                "R": 0
            },
            "StateEndingType": "SameDay",
            "StateID": "busy",
            "TextIsRequired": false
        }
    ]
}

Data Model¶

ExternalGetStatesResult¶

Array (State)

State¶

StateID string
Caption string
StateColor StateColor
StateEndingType string (NoRequired, SameDay, or Required)
TextIsRequired bool

StateColor¶

R int (0 - 255)
G int (0 - 255)
B int (0 - 255)