endpoint-list.md

EndPoint List

1. Users Endpoints

   • Create a new user Post /v1/users
   • Signin User Post /v1/signin
   • Refresh Token Post /v1/refresh
   • Change Password from a user Post /v1/users/change-password
   • Modify data of a user Put /v1/users/{iduser}
   • Read a specific user Get /v1/users?iduser={userID}
   • Read all users Get /v1/users
   • Search by name to users Get /v1/users?name={ParamVar}
   • Delete a specific user Delete /v1/users/{iduser}
   • Forgot your password Post /v1/password/email
   • Get user token and response if is valid or not Get /v1/password/reset/{token}
   • Reset Password Post /v1/password/reset

   ⚠️ *Note:

   To activate the password recovery function, add an email and your password. link: Func send() in the send () function

   To send emails with your gmail you must disable Control access to less secure apps GMAIL

   And add the page path of the website developed to capture the token add it in the function: Func GenerateEmailToResetPassword()

   The password recovery token has a duration of 1 hour.

2. Reports Endpoints

   • Create a victim report Post /v1/reports
   • Modify report state Patch /v1/reports/{idreport}
   • Update data from a report Put /v1/reports/{idreport}
   • Read a report list Get /v1/reports?state={varState}&offset={varOffset}&limit={varLimit}
   • Read a specific report Get /v1/reports?idreport={ParamVar}
   • Read a specific report by victim-id Get /v1/reports?victimID={ParamVar}
   • Read all reports Get /v1/reports
   • Delete a specific report Delete /v1/reports/{idreport}

3. Victims Endpoints

   • Read a specific victim Get /v1/victims?idvictim={ParamVar}
   • Read all victims Get /v1/victims
   • Read all victims by report state Get /v1/victims?report-state={report-state}
   • Search a victim by NAME Get /v1/victims?victim-name={ParamVar}
   • Search victim by Filter Get /v1/victims?victim-name={victim-name}&country={country}&status={status}&report-state={report-state}&sort={sort_by order}
   • Update data from a victim Put /v1/victims/{idvictim}
   • Delete a specific victim Delete /v1/victims/{idvictim}
   • Get Base64 string PDF file of a ID-victims array Get /v1/victims/pdf?idvictim={victim-ID}&idvictim={victim-ID}
   • Upload a victim's profile photo according to the victim's ID in S3 (AWS) Post /v1/victims/profile-img/{idvictim}
   • Delete the victim's profile photo according to the victim's ID in S3 (AWS). Delete /v1/victims/profile-img/{idvictim}

4. Victim_Translations Endpoints

   • Add a new victim translation Post /v1/victims/{idvictim}/victim-translations
   • Update a victim translation Put /v1/victim-translations/{idvictim-translation}
   • Read a specific translation Get /v1/victim-translations?idvictim-translation={translationID}
   • Read all translations from a victim Get /v1/victim-translations?idvictim={victimID}
   • Delete a specific translation Delete /v1/victim-translations/{idvictim-translation}

5. Victim_Medias Endpoints

   • Add a new victim media Post /v1/victims/{idvictim}/victimmedias
   • Read a specific victim media Get /v1/victimmedias?idvictimmedia={victim-mediaID}
   • Read all media from a victim Get /v1/victimmedias?idvictim={victimID}
   • Delete a specific victim media Delete /v1/victimmedias/{idvictimmedia}
   • Upload Victim Media File in S3 (AWS) Post /v1/victimmedias/upload

6. Incidents Endpoints

   • Add a new incident Post /v1/victims/{idvictim}/incidents
   • Update a specific incident Put /v1/incidents/{idincident}
   • Read all incidents from a victim Get /v1/incidents?idvictim={victimID}
   • Delete a specific incident Delete /v1/incidents/{idincident}

7. Incidents_Translations Endpoints

   • Add a new incident translation Post /v1/incidents/{idincident}/incident-translations
   • Read a specific incident translation Get /v1/incident-translations?idincident-translation={idincident-translationID}
   • Read all translations from a incident Get /v1/incident-translations?idincident={incidentID}
   • Update a incident translation Put /v1/victim-translations/{idvictim-translation}
   • Delete a specific incident translation Delete /v1/incident-translations/{idincident-translation}

8. Incident_Medias Endpoints

   • Add a new incident media Post /v1/incidents/{idincident}/incident-medias
   • Read a specific incident media Get /v1/incident-medias?idincident-media={incident-mediaID}
   • Read all media from a incident Get /v1/incident-medias?idincident={incidentID}
   • Delete a specific incident media Delete /v1/incident-medias/{idincident-media}
   • Upload Incident Media File in S3 (AWS) Post /v1/incident-medias/upload

9. Options Endpoints

   • Add a new option Post /v1/options
   • Get all options Get /v1/options
   • Delete an option Delete /v1/options/{optionid}