class GdsApi::SupportApi
@api documented
def anonymous_feedback(options = {})
def anonymous_feedback(options = {}) uri = "#{endpoint}/anonymous-feedback" + query_string(options) get_json(uri) end
def create_anonymous_long_form_contact(request_details)
def create_anonymous_long_form_contact(request_details) post_json("#{endpoint}/anonymous-feedback/long-form-contacts", long_form_contact: request_details) end
def create_feedback_export_request(request_details)
def create_feedback_export_request(request_details) post_json("#{endpoint}/anonymous-feedback/export-requests", export_request: request_details) end
def create_global_export_request(request_details)
def create_global_export_request(request_details) post_json("#{endpoint}/anonymous-feedback/global-export-requests", global_export_request: request_details) end
def create_page_improvement(params)
-
(HTTPErrorResponse)
- if the request returns an error
Returns:
-
(GdsApi::Response)
- The wrapped http response from the api. Responds to the following:
Parameters:
-
params
(Hash
) -- Any attributes that relate to a Page Improvement.
def create_page_improvement(params) post_json("#{endpoint}/page-improvements", params) end
def create_problem_report(request_details)
def create_problem_report(request_details) post_json("#{endpoint}/anonymous-feedback/problem-reports", problem_report: request_details) end
def create_service_feedback(request_details)
def create_service_feedback(request_details) post_json("#{endpoint}/anonymous-feedback/service-feedback", service_feedback: request_details) end
def document_type_list
def document_type_list get_json("#{endpoint}/anonymous-feedback/document-types") end
def document_type_summary(document_type, options = {})
def document_type_summary(document_type, options = {}) uri = "#{endpoint}/anonymous-feedback/document-types/#{document_type}" + query_string(options) get_json(uri) end
def feedback_by_day(date, page = 1, per_page = 100)
def feedback_by_day(date, page = 1, per_page = 100) uri = "#{endpoint}/feedback-by-day/#{date.strftime('%Y-%m-%d')}?page=#{page}&per_page=#{per_page}" get_json(uri) end
def feedback_export_request(id)
def feedback_export_request(id) get_json("#{endpoint}/anonymous-feedback/export-requests/#{id}") end
def mark_reviewed_for_spam(request_details)
-
request_details
(Hash
) -- Containing keys that match IDs of Problem
def mark_reviewed_for_spam(request_details) put_json("#{endpoint}/anonymous-feedback/problem-reports/mark-reviewed-for-spam", reviewed_problem_report_ids: request_details) end
def organisation(organisation_slug)
def organisation(organisation_slug) get_json("#{endpoint}/organisations/#{organisation_slug}") end
def organisation_summary(organisation_slug, options = {})
def organisation_summary(organisation_slug, options = {}) uri = "#{endpoint}/anonymous-feedback/organisations/#{organisation_slug}" + query_string(options) get_json(uri) end
def organisations_list
def organisations_list get_json("#{endpoint}/organisations") end
def problem_report_daily_totals_for(date)
def problem_report_daily_totals_for(date) date_string = date.strftime("%Y-%m-%d") get_json("#{endpoint}/anonymous-feedback/problem-reports/#{date_string}/totals") end
def problem_reports(options = {})
page_size: 50
pages: 50,
current_page: 1,
total_count: 1000,
]
...
},
created_at: "2015-01-01T16:00:00.000Z"
reviewed: true,
marked_as_spam: false,
path: "/skiing",
user_agent: "Safari",
referrer: "https://www.gov.uk/browse",
url: "http://www.dev.gov.uk/skiing",
what_doing: "Skiing",
what_wrong: "Yeti",
type: "problem-report",
id: 1,
{
results: [
#=> {
support_api.problem_reports({ from_date: '2016-12-12', to_date: '2016-12-13', page: 1, include_reviewed: true }).to_h
# @example
* +:include_reviewed+ - if true, includes reviewed reports in the list.
* +:page+ - page number for reports.
* +:to_date+ - to date for list of reports.
* +:from_date+ - from date for list of reports.
# ==== Options [+Hash+]
The results are ordered date descending.
If no options are supplied, the first page of unreviewed feedback is returned.
Makes a +GET+ request.
Fetch a list of problem reports.
def problem_reports(options = {}) uri = "#{endpoint}/anonymous-feedback/problem-reports" + query_string(options) get_json(uri) end