Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request]: Create API for Establishments #70

Open
rt4914 opened this issue Nov 5, 2024 · 2 comments · May be fixed by #75
Open

[Feature Request]: Create API for Establishments #70

rt4914 opened this issue Nov 5, 2024 · 2 comments · May be fixed by #75
Assignees
Labels
feature Building something new

Comments

@rt4914
Copy link
Owner

rt4914 commented Nov 5, 2024

Is your feature request related to a problem? Please describe.

We need CRUD APIs for Establishments

Describe the solution you'd like

Only authorised users can call these APIs

I have added * with some params which means its required/mandatory.

CREATE

  • In this the api will accept following things: name*, latitude, longitude, maps_location, address_line_1*, address_line_2, city*, state*, country*, pincode*
  • The header will contain user related information, verify that this user is associated with a doctor_profile (because only doctors can handle establishments). Basically this will help you fetch the doctor_profile_id
  • Now based on these params, first add the address details to Address model and then use that address_id in establishment model.
  • Make sure DoctorEstablishment model also has a entry to connect doctor with establishment.
  • Return the created object in json response.

UPDATE

  • In this the api will accept following things: establishment_id*, name, latitude, longitude, maps_location, address_line_1, address_line_2, city, state, country, pincode
  • The header will contain user related information, verify that this user is associated with a doctor_profile (because only doctors can handle establishments). Basically this will help you fetch the doctor_profile_id
  • Now update whichever is required either in Establishment model or in Address model.
  • Return the updated object in json response.

DELETE

  • This api will accept: establishment_id
  • The header will contain user related information, verify that this user is associated with a doctor_profile (because only doctors can handle establishments). Basically this will help you fetch the doctor_profile_id
  • If authorised, delete the establishment.
  • Return success related message.

GET ALL

  • NO AUTHORISATION REQUIRED.
  • This api will accept any type of filter params like name, city, state, country, pincode, doctor_profile_id (via header). These params should be part of URL.
  • Based on any of these params filter should get applied and corresponding results should be returned.

GET

  • NO AUTHORISATION REQUIRED.
  • This api will accept: establishment_id. This should be part of URL.
  • Return the establishment.

Describe alternatives you've considered

No response

Additional context

No response

@rt4914 rt4914 added the feature Building something new label Nov 5, 2024
@aniketpatidar aniketpatidar self-assigned this Nov 7, 2024
@aniketpatidar
Copy link
Collaborator

GET ALL
NO AUTHORISATION REQUIRED.
This api will accept any type of filter params like name, city, state, country, pincode, doctor_profile_id (via header).
Based on any of these params filter should get applied and corresponding results should be returned.

Please clarify if all filter parameters (e.g., name, city, state) need to be passed as key-value pairs in the header, similar to how an Authorization header works, or if they should be passed differently.

GET
NO AUTHORISATION REQUIRED.
This api will accept: establishment_id
The header will contain user related information, verify that this user is associated with a doctor_profile (because only doctors can handle establishments). Basically this will help you fetch the doctor_profile_id
If authorised, return the establishment.

Although authorization isn’t required for this API, user-related information still needs to be included in the header. Please clarify the purpose of this requirement.

@rt4914
Copy link
Owner Author

rt4914 commented Nov 11, 2024

@aniketpatidar Updated the description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Building something new
Projects
None yet
2 participants