GET api/UserReports

Retrieves a list of custom (third-party) reports.

Request

(empty)

Response

Body

Content Type: application/xml or application/json
List of reports or an error message.

XML JSON
<Response>                             
  <Result>                             <!--Array of 'Item'--> 
    <Item>                             
      <ID>long</ID>                    <!--Unique report ID--> 
      <Name>string</Name>              <!--Description of the report--> 
      <Scope>string</Scope>            <!--Description of the scope of the report--> 
      <ScopeType>string</ScopeType>    <!--'Practice', 'Global', 'Workgroup' or 'Department'--> 
      <ScopeID>long</ScopeID>          <!--Unique ID of the scope of the above type--> 
    </Item>                            
  </Result>                            
  <Message>string</Message>            <!--Error message--> 
</Response>                            
{                               
   "Result": [{                 
      "ID": "long",             // Unique report ID
      "Name": "string",         // Description of the report
      "Scope": "string",        // Description of the scope of the report
      "ScopeType": "string",    // 'Practice', 'Global', 'Workgroup' or 'Department'
      "ScopeID": "long"         // Unique ID of the scope of the above type
   }],                          
   "Message": "string"          // Error message
}                               
                                

Status Codes

Code Condition
200 OK The operation completed successfully.
401 Unauthorized Access token is invalid, expired or not specified.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.