getUsers

Description

Example request

https://www.rundowncreator.com/channel4news/API.php
     ?APIKey=edharken
     &APIToken=HNe2ADG0nBTiC8Q8WiVfsxeG5ip51A
     &Action=getUsers

Example response

[
    {
        "UserID": 1,
        "Username": "edharken",
        "FirstName": "Ed",
        "LastName": "Harken",
        "EmailAddress": "ed@channel4news.com",
        "Type": "Administrator",
        "Activated": 1
    },
    {
        "UserID": 2,
        "Username": "ronburgundy",
        "FirstName": "Ron",
        "LastName": "Burgundy",
        "EmailAddress": "ron@channel4news.com",
        "Type": "Producer",
        "Activated": 1
    }
]

Required parameters

Optional parameters

UserID	integer	if set, only the user with the UserID specified will be returned
Username	string	if set, only the user with the Username specified will be returned
FirstName	string	if set, only users with the FirstName specified will be returned
LastName	string	if set, only users with the LastName specified will be returned
EmailAddress	string	if set, only users with the EmailAddress specified will be returned
Type	string	if set, only users of the Type specified will be returned. Possible values include Viewer, Writer, Producer, and Administrator
Activated	boolean	if set to true, only active users will be returned. If set to false, only inactive users will be returned. If not set, both active and inactive users will be returned
GetTimestamps	boolean	if set to true, the dates/times that the user was created and last modified will be included in the response returned in the DateCreated and DateModified fields. If set to false, they will not. Defaults to false
OrderBy	string	if set, the results in the response returned will be ordered by the field specified. Possible values include UserID, FirstName, LastName, Username, and Type. Defaults to UserID
Descending	boolean	if set to true, the results in the response returned will be sorted in descending order. Defaults to false

Returns

UserID	integer	the user's unique ID
DateCreated	integer	the date/time that the user was created. Only returned if GetTimestamps is set to true
DateModified	integer	the date/time that the user was last modified. Only returned if GetTimestamps is set to true
Username	string	the user's username
FirstName	string	the user's first name
LastName	string	the user's last name
EmailAddress	string	the user's email address. Only returned if you're an administrator or higher
Type	string	the user's type. Possible values include Viewer, Writer, Producer, and Administrator
Activated	boolean	true if the user's account is active, false if it's not