GET user account api - Tizra/Tizra-Customer-Tracker GitHub Wiki

(Server) GET User account information

When a GET is performed on a management URL for a user account a description of that account is returned as a JSON record. This includes account status, any defined metadata for the account and so on. Accounts are treated as objects of meta-type UserData, but have some custom fields, just as offers and excerpts do. An example user record might be:

{
    "email": "[email protected]", 
    "meta-type": "UserData", 
    "props": {
        "AdminTags": [
            "tizra.com", 
            "blarg", 
            "avectra", 
            "sdfsdf", 
            "code", 
            "remote"
        ], 
        "City": [
            "Providence"
        ], 
        "CountryCode": "PL", 
        "Email": "", 
        "EmailAddress": "", 
        "FirstName": "david", 
        "JobFunction": "232", 
        "LastName": "testo", 
        "Province": [], 
        "SchoolDistrictOrg": "", 
        "State": "", 
        "Street": "9 Catalpa Road", 
        "Street2": "", 
        "Zip": "02906"
    }, 
    "tizra-id": "pfss", 
    "url-id": "pfss", 
    "user-status": 1, 
    "user-status-description": "Active"
}

Records returned by the system may include document-oriented information on publishing status, MetaSources, etc. These document-oriented aspects may have future applications in account management, but should be ignored at this time. The system man also return duplicate data with alternate field names (for compatibility). The response shown above includes only those fields whose use is both supported and preferred at this time.

The account name appears as email; this reflects Tizra's preference for the use of email addresses as account names, but this is not a requirement imposed by the system. As shown, it is possible to configure a custom property to hold an email address if preferred.