incident_mgr_list_by_type

Back to SOAP Architecture Method Reference

Description

The incident_mgr_list_by_type method lists the details of incidents associated with players or edge servers for a specific Incident type on your domain.

Parameters

Parameter Description Type Required (R) or Optional (O)
domain_id The unique ID# of the domain. bstypes:ResourceId O
type_codes

The incident type. Options include:

  • 2 = Display device error
  • 3 = Display not fullscreen
  • 4 = Display resolution mismatch
  • 5 = Display temperature warning
  • 6 = Display temperature critical
  • 7 = Display orientation mismatch
  • 103 = Playback error
  • 104 = Playback missing file
  • 105 = Playback truncated file
  • 106 = Playback disk space
  • 107 = Playback expired file
  • 204 = Host/player MIA
  • 205 = Host/player unexpected shutdown
  • 206 = Host/player difficulties polling
  • 207 = Host/player performance problem
  • 208 = Host/player application fault
  • 209 = Host/player memory exhausted
  • 210 = Host/player deadlock
  • 211 = Host/player offline during business hours
  • 212 = Host/player URL sync failed
  • 213 = Host/player backup master activated
  • 305 = Domain quota exceeded
 string R

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the incident. bstypes:ResourceId R
resource_id The unique ID# of the resource (player or edge server) related to this incident. bstypes:ResourceId R
status_code The status code for this incident:
  • 2 = Warning
  • 3 = Error
  • 4 = User Intervention
  • 5 = Resolved
  • 6 = Resolved locally but not reported
  • 7 = Resolved but reported anyway
 bstypes:IncidentStatus R
type_code The type code for this incident:
  • 2 = Display device error
  • 3 = Display not fullscreen
  • 4 = Display resolution mismatch
  • 5 = Display temperature warning
  • 6 = Display temperature critical
  • 7 = Display orientation mismatch
  • 103 = Playback error
  • 104 = Playback missing file
  • 105 = Playback truncated file
  • 106 = Playback disk space
  • 107 = Playback expired file
  • 204 = Host/player MIA
  • 205 = Host/player unexpected shutdown
  • 206 = Host/player difficulties polling
  • 207 = Host/player performance problem
  • 208 = Host/player application fault
  • 209 = Host/player memory exhausted
  • 210 = Host/player deadlock
  • 211 = Host/player offline during business hours
  • 212 = Host/player URL sync failed
  • 213 = Host/player backup master activated
  • 305 = Domain quota exceeded
  • 10001-10025 = External incident types
 bstypes:IncidentType R
occurred_on The date time at which this incident occurred. bstypes:SimpleDateTime R
reported_on The date time at which this incident was reported. bstypes:SimpleDateTime R
resolved_on The date time at which this incident was resolved. bstypes:SimpleDateTime R
problem_description The description of the problem related to this incident. string R
resolved_description The description of the resolution related to this incident. string R
target_resource_id The unique ID# of the resource targeted by this incident. bstypes:ResourceId R
last_status_code_change_utc The last date time in UTC at which the status code for this incident was changed. bstypes:SimpleDateTime R
escalation_status The escalation status for this incident:
  • 1 = Trivial
  • 2 = Warning
  • 3 = Critical
  • 4 = Resolved
 bstypes:EscalationStatus R
domain_id The unique ID# of the domain. bstypes:ResourceId R
warning_escalation_tm_utc The last date time in UTC at which this incident was escalated to warning. bstypes:SimpleDateTime R
critical_escalation_tm_utc The last date time in UTC at which this incident was escalated to critical. bstypes:SimpleDateTime R