Knowledge Base

^{A custom value to identify the data related to the request in the response (you can see the transactionId in the response header).}

^Example:

• ^REQ000001
  

^{Note: This field is not related with the data to be retrieved, must be used by the client app in order to identify the request/response (if that is useful), the same value can be sended in multiple request (it’s not validated that the same value was sended before)}

^header

^Object

^{Specific data related to the response}

^resultCode

^text

^{The result code of the response, can be:}

^{·         error -> if errors were found}

^{·         ok -> if NO errors were found}

^messageCode

^text

^{The message code related to the result code of the response, can be:}

^Example:

^{messageDescription}

^text

^{The description of the message code}

^Example:

^{·         request ok}

^{·         Please check your params fields}

^{transactionId}

^text

^{The transactionId specified in the request, if no transactionId was sended in the request then the transacionId in the response will be null}

^errors

^Array

 ^{This field is present if there are errors in the request}

^fieldName

^text

^{The field with errors}

^fieldDesc

^text

 ^{The description of the error}

^Data

^Array

^{The specific response data related to the request}

^id

^int

^{The identifier of the profile}

^{Example: 1}

^text

^{The name of the profile}

^boolean

^{Used to access data in:}

• ^{Monitoring menu,} 
  
  • ^{Dashboard submenu}
    

^boolean

^{Used to access data in:} 

• ^{Monitoring menu,} 
  
  • ^{By Map submenu}
    

^int

^{Used to access data in:} 

• ^{Monitoring menu,} 
  
  • ^{By List submenu}
    
  • ^{By Filters submenu}
    
  • ^{Download Manager submenu}
    

^{These are the possible values this field can retrieve:}

• ^{0 -> the module cannot be accessed} 
  
• ^{1 -> allows access to the module, the user can't modify the content} 
  
• ^{2 -> Allows access to the module, the user can modify the content}
  

^boolean

^{Used to access data in:}

• ^{Monitoring menu,} 
  
  • ^{Snapshot Mosaic submenu}
    

^boolean

^{Used to access data in:}

• ^{Monitoring menu,} 
  
  • ^{Player Health submenu}
    

^boolean

^{Used to access data in:}

• ^{Monitoring menu,} 
  
  • ^{Operational Health submenu}
    

^boolean

^{Used to access data in:}

• ^{Monitoring menu,} 
  
  • ^{Location Compliance submenu}
    

^boolean

^{Used to access data in:}

• ^{Monitoring menu,} 
  
  • ^{Bandwidth submenu}
    

^boolean

^{Used to access data in:}

• ^{VDA menu,} 
  
  • ^{Monitoring submenu}
    

^boolean

^{Used to access data in:}

• ^{VDA menu,} 
  
  • ^{Health submenu}
    

^boolean

^{Used to access data in:}

• ^{Analytics menu} 
  
  • ^{Dashboard submenu}
    

^boolean

^{Used to access data in:}

• ^{Analytics menu} 
  
  • ^{Playbacks submenu}
    

^boolean

^{Used to access data in:}

• ^{Analytics menu} 
  
  • ^{Events submenu}
    

^boolean

^{Used to access data in:}

• ^{Analytics menu} 
  
  • ^{PageViews submenu}
    

^boolean

^{Used to access data in:} 

• ^{Analytics menu} 
  
  • ^{Sessions submenu}
    

^boolean

^{Used to access data in:} 

• ^{Analytics menu} 
  
  • ^{FTP submenu}
    

^boolean

^{Used to access data in:}

• ^{Locations menu} 
  
  • ^{List submenu}
    

^boolean

^{Used to access data in:} 

• ^{Locations menu} 
  
  • ^{Uploadsubmenu}
    

^boolean

^{Used to access data in:} 

• ^{Locations menu} 
  
  • ^{Player Set submenu}
    

^boolean

^{Used to access data in:}

• ^{Groups menu} 
  
  • ^{By Location submenu}
    

^boolean

^{Used to access data in:}

• ^{Groups menu} 
  
  • ^{Smart Groups submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Tags submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Media Library submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Files Library submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Media Feed submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Presentations submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Authorize Content submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Publish submenu}
    
    • ^{Location Tab}
      

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Publish submenu}
    
    • ^{Location Group Tab}
      

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Publish submenu}
    
    • ^{Smart Group Tab}
      

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Publish submenu}
    
    • ^{Update Presentation Tab}
      

^boolean

^{Used to access data in:} 

• ^{Content menu} 
  
  • ^{Publish submenu}
    
    • ^{Update Publish Tab}
      

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Publish submenu}
    
    • ^{Firmware Tab}
      

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Programming Log submenu}
    

^boolean

^{Used to access data in:} 

• ^{Content menu} 
  
  • ^{Wall submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Activity Log submenu}
    

^int

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Campaign submenu}
    

^boolean

^{It is used to change a status campaign to approved}

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Rundown submenu}
    

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Takeover submenu}
    

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Banners submenu}
    

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Manufacturer tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Brands tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Categories tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Revenue tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Fillers tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Asset Inserts tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Presentations tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Settings tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Reports tab}
      

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Inventory tab}
      

^int

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Inventory submenu}
    

^boolean

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Properties submenu}
    
    • ^{Disclaimer tab}
      

^int

^{Used to access data in:}

• ^{Campaign Manager menu} 
  
  • ^{Reports submenu}
    

^boolean

^{Used to access data in:} 

• ^{Player Config menu} 
  
  • ^{TV Control submenu}
    

^boolean

^{Used to access data in:}

• ^{Player Config menu} 
  
  • ^{Download Control submenu}
    

^boolean

^{Used to access data in:} 

• ^{Player Config menu} 
  
  • ^{Remote Setup submenu}
    

^boolean

^{Used to access data in:}

• ^{Player Config menu} 
  
  • ^{B-Deploy submenu}
    

^boolean

^{Used to access data in:}

• ^{Player Config menu} 
  
  • ^{Player Setup submenu}
    

^boolean

^{Used to access data in:}

• ^{Player Config menu} 
  
  • ^{Smart Actions submenu}
    

^boolean

^{Used to access data in:}

• ^{Player Config menu} 
  
  • ^{Stock Market submenu}
    

^boolean

^{Used to access data in:}

• ^{System Config menu} 
  
  • ^{Licenses submenu}
    

^boolean

^{Used to access data in:}

• ^{System Config menu} 
  
  • ^{Profiles/Users submenu}
    

^boolean

^{Used to access data in:}

• ^{System Config menu} 
  
  • ^{Settings submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{Playlist submenu}
    

^boolean

^{Used to access data in:}

• ^{Content menu} 
  
  • ^{dayparting submenu}
    

^boolean

^{Used to access data in:}

• ^{System Config menu} 
  
  • ^{Clients submenu}
    

^error

^text

^{The type of the error, can be:}

• ^unauthorized
  
• ^{invalid_token}
  

^text

^{The description of the error, for the "invalid_token", this field retrieves the bearer token you're sending}