Reports
| API | Description |
|---|---|
| GET api/cases/{caseId}/reports |
Get all the Reports available to the User and appropriate to this Case |
| PUT api/reports/pdfprinter |
No documentation available. |
| GET api/cases/{caseId}/reports/{reportId}/pdf |
Pull up the Report information for the specified case, return the Template as a Pdf NOTE: Does not currently bind to the data, DO NOT USE at present |
| GET api/cases/{caseId}/reports/name/{reportName} |
Get the desired Report Detail, which includes display template and content included content questions will be filtered by the User's security access |
| GET api/cases/{caseId}/reports/{reportId} |
Get the desired Report Detail, which includes display template and content included content questions will be filtered by the User's security access |
| PUT api/reports/{id}/template?reportTemplate={reportTemplate} |
Save changes to an existing report, changing the template only |
| GET api/Reports |
Get all the Reports available to the User |
| PUT api/Reports?reportId={reportId} |
Save changes to an existing report, changing the template and/or the Questions included in the report |
| PUT api/Reports/{id} |
Save changes to an existing report, changing the template only |
| POST api/Reports?organizationId={organizationId} |
Add a new report Will add the report to the organization if specificied |
| DELETE api/Reports/{id} |
Delete the report at the associated id Requires admin access |
Craig
| API | Description |
|---|---|
| PUT api/cases/matches |
No documentation available. |
| GET api/cases/{caseId}/cues |
No documentation available. |
Organizations
| API | Description |
|---|---|
| GET api/organizations?roleName={roleName} |
No documentation available. |
| GET api/organizations/details |
Get all Organizations this user has access to with their detailed roles and states |
| GET api/organizations/{organizationId}/reports |
No documentation available. |
| GET api/organizations/{organizationId}/roles |
No documentation available. |
| GET api/organizations/{organizationId}/users |
No documentation available. |
| POST api/organizations/{organizationId}/users |
Add a user with the provided information Requires adminstrator for the specificied organization |
| GET api/organizations/{organizationId}/roles/{organizationRoleId}/users |
No documentation available. |
Users
| API | Description |
|---|---|
| GET api/organizations/{organizationId}/users/{userId}/roles |
Get all the roles for the specified userId. This method requires that admin role |
| POST api/organizations/{organizationId}/users/{userId}/roles/{roleId} |
Add the specified role to the specified user This method requires the admin role |
| DELETE api/organizations/{organizationId}/users/{userId}/roles/{roleId} |
Removes the specified role to the specified user This method requires the admin role |
Sections
| API | Description |
|---|---|
| GET api/cases/{caseId}/sections |
Get all the sections for the Case (that this user is allowed to see) |
| GET api/cases/{caseId}/fullsections |
Get the fully hydrated sections of a case |
| GET api/cases/{caseId}/sections/{caseSectionId} |
Get a section specific to the case |
| GET api/cases/{caseId}/fullsections/{caseSectionId} |
Get a fully hydrated section specific to the case |
| PUT api/sections/types/{questionType}?questionTypeName={questionTypeName} |
Update the template, formatting, and/or validation rules for the QuestionType Only non-null fields of the above will be updated |
Cues
| API | Description |
|---|---|
| GET api/cues/{discipline} |
Return all the cues within a specific discipline (e.g. all "Fire" or "LEO" cues) |
Cases
| API | Description |
|---|---|
| GET api/cases/mine?page={page}&pageSize={pageSize}&sortBy={sortBy}&sortDirection={sortDirection}&skip={skip}&take={take} |
Grab the cases that this user has acted on |
| GET api/Cases/{id}/Detail |
No documentation available. |
| GET api/cases/{id}/history?includeViews={includeViews} |
Get the history (log) of the Case |
| GET api/cases/{caseId}/history/{historyId} |
Gets the Case as snapshotted at a particular point in history If history did not include a snapshot of the case, returns NotFound |
| POST api/cases/update |
No documentation available. |
| GET api/Cases?page={page}&pageSize={pageSize}&sortBy={sortBy}&sortDirection={sortDirection}&skip={skip}&take={take} |
Get all Cases this user can see |
| GET api/Cases/{id} |
Get a Case summary by it's Guid id. |
| PUT api/Cases/{id} |
No documentation available. |
| POST api/Cases?transitionId={transitionId} |
Create a case from the data in CaseSimple If no transitionId is supplied, use the first "Create" transition If a transitionId is supplied, use that if it is a "Create" transition |
| DELETE api/Cases/{id} |
No documentation available. |
Answers
| API | Description |
|---|---|
| GET api/cases/{caseId}/questions/{questionId}/answers |
All answers for this case and question |
| GET api/cases/{caseId}/questions/{questionId}/answers/{answerId} |
Get a particular answer |
| PUT api/cases/{caseId}/questions/{questionId}/answers/{answerId} |
Update an existing answer by Id |
| PUT api/cases/{caseId}/questions/{questionId}/answers/replace |
Replace any answers to this question with the answers provided Will update matching answers (by Id) Will add new answers Will delete answers currently saved for question but not in the provided answers list |
| POST api/cases/{caseId}/questions/{questionId}/answers |
Add an answer to this Question. Method will fail if an answer already exists when multiple answers are not allowed |
| DELETE api/cases/{caseId}/questions/{questionId}/answers/{answerId} |
Delete the provided answer by Id |
Questions
| API | Description |
|---|---|
| GET api/cases/{caseId}/sections/{sectionId}/questions |
Get all the questions appropriate to this case within a particular section |
| GET api/cases/{caseId}/questions/{questionId} |
Get a particular question for the Case in Detail |
| GET api/cases/{caseId}/sections/{sectionId}/questions/{questionId} |
Get a particular question for the Case in Detail |
| POST api/questions |
No documentation available. |
| GET api/questions/types |
Get all the QuestionTypes |
| PUT api/questions/types/{questionTypeName} |
Update the template, formatting, and/or validation rules for the QuestionType Only non-null fields of the above will be updated |
Search
| API | Description |
|---|---|
| GET api/cases/searches |
Returns a sample search object |
| PUT api/cases/searches/details?page={page}&pageSize={pageSize}&sortBy={sortBy}&sortDirection={sortDirection}&skip={skip}&take={take} |
No documentation available. |
| PUT api/cases/searches?page={page}&pageSize={pageSize}&sortBy={sortBy}&sortDirection={sortDirection}&skip={skip}&take={take} |
No documentation available. |
| PUT api/users/searches?page={page}&pageSize={pageSize}&sortBy={sortBy}&sortDirection={sortDirection}&skip={skip}&take={take} |
No documentation available. |
Transitions
| API | Description |
|---|---|
| GET api/organizations/{organizationId}/transitions |
Get all Create Transitions that do not require a Case for this organization. These are "Create" type Transitions |
| PUT api/cases/{caseId}/transitions/{transitionId}/apply |
Apply the Transition to the case (assuming the user has appropriate privileges) |
| GET api/Transitions?caseId={caseId} |
Get all the Transitions appropriate to this case and its current state Only Transitions available to the current user will be included |
| GET api/Transitions/{id}?caseId={caseId} |
Get a particular Transition if the user has access |
Attachments
| API | Description |
|---|---|
| GET api/cases/{caseId}/attachments |
No documentation available. |
| GET api/cases/{caseId}/attachments/{attachmentId} |
Return the referenced attachment |
| PUT api/cases/{caseId}/attachments/{attachmentId} |
No documentation available. |
| POST api/cases/{caseId}/attachments |
Add an attachment |
| POST api/cases/{caseId}/attachmentchunks |
Add an attachment in chunks |
| DELETE api/cases/{caseId}/attachments/{attachmentId} |
Add an attachment |
| GET api/cases/{caseId}/attachments/{attachmentId}/permissions |
Get permitted attachment ids |
| GET api/cases/{caseId}/attachments/{attachmentId}/roles |
Get permitted attachment roles |
| GET api/cases/{caseId}/attachments/{attachmentId}/users |
Get permitted attachment users |
Analytics
| API | Description |
|---|---|
| GET api/analytics/organizations/{organizationId} |
Returns all analysis queries available for this organization |
| GET api/analytics/organizations/{organizationId}/questions |
No documentation available. |
| POST api/analytics/organizations/{organizationId}/questions |
Get the questions available for analysis These can be used as the "output" to key on These can be used to filter on |
| GET api/analytics/organizations/{organizationId}/states |
Get the states available for analysis to this user |
| GET api/analytics/{analysisId} |
Run the desired analysis query against current data |
| POST api/Analytics |
Add a new AnalyticQuery |
| PUT api/Analytics?analysisId={analysisId} |
Save changes to a particular analytic query |
| DELETE api/Analytics/{id} |
Delete a particular analytic query |
Token
| API | Description |
|---|---|
| GET api/Token?clientUrl={clientUrl} |
No documentation available. |