apollo.status package

Module contents

Contains possible interactions with the Apollo Status Module

class apollo.status.StatusClient(webapolloinstance, **requestArgs)

Bases: apollo.client.Client

CLIENT_BASE = '/availableStatus/'
add_status(status)

Add a status value

Parameters:status (str) – New status
Return type:dict
Returns:A dictionnary containing status description
delete_status(id_number)

Delete a status

Parameters:id_number (int) – status ID number
Return type:dict
Returns:an empty dictionary
get_statuses()

Get all statuses available in this Apollo instance

Return type:list of dicts
Returns:list of status info dictionaries
show_status(status)

Get a specific status

Parameters:status (str) – Status to show
Return type:dict
Returns:A dictionnary containing status description
update_status(id_number, new_value)

Update a status name

Parameters:
  • id_number (int) – status ID number
  • new_value (str) – The new status name
Return type:

dict

Returns:

an empty dictionary