API.get request by id
Rogerio Albandes edited this page Aug 2, 2020
·
4 revisions
Returns request by ticket ID.
-
URL
http://helpdezk_url/api/user/request
-
Method:
GET -
URL Params
Required:
Param Description Type token Authentication token string code Ticket ID int -
Success Response:
-
Code: 200
Content:Param Description Type code Ticket ID int code_fmt Formated ticket code string status Status name string idstatus Status ID int entry_date Registration date date in_charge Responsible name for the ticket strint subject Ticket subject string description Ticket description text idperson ID of the person linked to the token int person_name Person name who recorded the note string possibletoreopen its possible to reopen the ticket bool idarea Area ID int area_name Area name string idtype Type ID int type_name Type name string iditem Item ID int item_name Item name string idservice Service ID int service_name Service name string idreason Reason ID int reason_name Reason name string attachments Ticket attachments object filename Name of file string attach_url Url of attachment string notes Ticket notes object note_description Note description text idperson Person ID who recorded the note int person_name Person name who recorded the note string ip_address IP address where the note was recorded string date Registration date date date_fmtd Registration date formated date time Registration time time time_fmtd Registration time time execution_date Execution date by operator, if available date service_time Service time, if available time service_time_fmtd Service time formated time start_hour Start service time time finish_hour Finish service time time callback Callback call bool hour_type Hour type string flag_opened Read bool attachments Note attachment object filename Name of note file attached string attach_url Url of note attachment string Example:
{ "result": { "success": { "code": "202002000007", "code_fmt": "2020-02.000007", "status": "7 - Atendida ", "idstatus": "5", "entry_date": "02/04/2020 11:10 AM", "in_charge": "Rogério Albandes", "subject": "Error sending messages", "description": "Good morning, when trying to write a new message via Help for emails ...", "idperson": "768", "person_name": "Demo User", "possibletoreopen": "1", "idarea": "60", "area_name": "IT - BACKOFFICE", "idtype": "143", "type_name": "Helpdesk", "iditem": "231", "item_name": "Send emails by cron", "idservice": "856", "service_name": "Doubt about the use of the method.", "idreason": "40", "reason_name": "Not in the manual.", "attachments": [ { "filename": "2020-02-21_180951.png", "attach_url": "http://ratify.helpdezk.cc/app/uploads/helpdezk/attachments/1.png" }, { "filename": "php.jpg", "attach_url": "http://ratify.helpdezk.cc/app/uploads/helpdezk/attachments/2.jpg" } ], "notes": [ { "note_description": "Solicitação Encerrada", "idperson": "768", "person_name": "Comunicação ", "ip_address": "181.220.0.209", "date": "2020-02-11 15:33:34", "date_fmtd": "02/11/2020 03:33 PM", "execution_date": "00/00/0000", "service_time": "0", "service_time_fmtd": null, "start_hour": "", "finish_hour": "", "callback": "0", "hour_type": "0", "flag_opened": "0", "attachments": [] }, { "note_description": "Aguardando aprovação do usuário", "idperson": "18", "person_name": "Rogério da Costa Albandes", "ip_address": "181.220.0.209", "date": "2020-02-04 11:46:42", "date_fmtd": "02/04/2020 11:46 AM", "execution_date": "00/00/0000", "service_time": "0", "service_time_fmtd": "00h 00min 00s", "start_hour": "0", "finish_hour": "0", "callback": "0", "hour_type": "0", "flag_opened": "1", "attachments": [] }, { "note_description": "Hello. Solved ! Regards", "idperson": "18", "person_name": "Rogério Albandes", "ip_address": "181.220.0.209", "date": "2020-02-04 11:45:43", "date_fmtd": "02/04/2020 11:45 AM", "execution_date": "02/04/2020", "service_time": "0.6", "service_time_fmtd": "00h 00min 36s", "start_hour": "11:45:06", "finish_hour": "11:45:42", "callback": "0", "hour_type": "0", "flag_opened": "1", "attachments": [] }, { "note_description": "Solicitação Assumida", "idperson": "18", "person_name": "Rogério Albandes", "ip_address": "181.220.0.209", "date": "2020-02-04 11:44:49", "date_fmtd": "02/04/2020 11:44 AM", "execution_date": "00/00/0000", "service_time": "0", "service_time_fmtd": "00h 00min 00s", "start_hour": "0", "finish_hour": "0", "callback": "0", "hour_type": "0", "flag_opened": "1", "attachments": [ { "filename": "eletricpan-on.png", "attach_url": "http://ratify.helpdezk.cc/app/uploads/helpdezk/noteattachments/4.png" }, { "filename": "radiator-on.png", "attach_url": "http://ratify.helpdezk.cc/app/uploads/helpdezk/noteattachments/5.png" }, { "filename": "iot-cisco.png", "attach_url": "http://ratify.helpdezk.cc/app/uploads/helpdezk/noteattachments/3.png" } ] }, { "note_description": "Solicitação Repassada para atendente Rogério Albandes", "idperson": "15", "person_name": "Roger Garcia Mendes", "ip_address": "181.220.0.209", "date": "2020-02-04 11:32:02", "date_fmtd": "02/04/2020 11:32 AM", "execution_date": "00/00/0000", "service_time": "0", "service_time_fmtd": "00h 00min 00s", "start_hour": "0", "finish_hour": "0", "callback": "0", "hour_type": "0", "flag_opened": "1", "attachments": [] }, { "note_description": "Solicitação Cadastrada", "idperson": "768", "person_name": "Comunicação ", "ip_address": "181.220.0.209", "date": "2020-02-04 11:10:05", "date_fmtd": "02/04/2020 11:10 AM", "execution_date": "00/00/0000", "service_time": "0", "service_time_fmtd": "00h 00min 00s", "start_hour": "0", "finish_hour": "0", "callback": "0", "hour_type": "0", "flag_opened": "0" } ], "evaluate": [ { "question": "Do you approve the operators attendance?", "answers": [ { "value": "A", "name": "Yes.", "icon": null, "checked": 1 }, { "value": "N", "name": "No.", "icon": null, "checked": 0 }, { "value": "O", "name": "Yes, with observation.", "icon": null, "checked": 0 } ] }, { "question": "How would you rate the service provided by the analyst(s): ", "answers": [ { "value": "2", "name": "Regular", "icon": "http://localhost/erick/app/uploads/icons/ico_regular.gif", "checked": "0" }, { "value": "3", "name": "Good", "icon": "http://localhost/erick/app/uploads/icons/ico_bom.gif", "checked": "0" }, { "value": "4", "name": "Great", "icon": "http://localhost/erick/app/uploads/icons/ico_otimo.gif", "checked": "0" } ] } ] } } }
-
-
Error Response:
-
Code: 200
Content:{ "result": { "error": { "code": "9999", "message": "Error message" } } }
Example:
{ "result": { "error": { "code": "0091", "message": "Request not found." } } }
-