Skip to Content
Dgmos dokümantasyonu yayında 🎉
DokümantasyonAPIContact Management

Contact Management

This page is auto-generated from cmd/web/routes.go.

Endpoint List

MethodPathHandlerRequest
Post/api/modules/create-calenderhandlers.Repo.CreateCalenderCalenderRequest.CalenderEventCreateRequest
Post/api/modules/create-calender-memberhandlers.Repo.CreateCalenderMemberCalenderRequest.CalenderMemberCreateRequest
Post/api/modules/create-contacthandlers.Repo.CreateContactContactRequest.ContactCreateRequest
Post/api/modules/create-contact-categoryhandlers.Repo.CreateContactCategoryContactRequest.ContactCategoryCreateRequest
Post/api/modules/delete-calenderhandlers.Repo.DeleteCalenderrequests.DeleteRequest
Post/api/modules/delete-contacthandlers.Repo.DeleteContactContactRequest.ContactDeleteRequest
Post/api/modules/delete-contact-categoryhandlers.Repo.DeleteContactCategoryContactRequest.ContactCategoryDeleteRequest
Post/api/modules/list-calenderhandlers.Repo.ListCalenderrequests.ListRequest
Post/api/modules/list-contacthandlers.Repo.ListContactrequests.ListRequest
Post/api/modules/list-contact-categoryhandlers.Repo.ListContactCategoryrequests.ListRequest
Post/api/modules/meeting-listhandlers.Repo.ListCalenderInvited-
Post/api/modules/read-calenderhandlers.Repo.ReadCalenderrequests.ReadRequest
Post/api/modules/read-contacthandlers.Repo.ReadContactrequests.ReadRequest
Post/api/modules/read-contact-categoryhandlers.Repo.ReadContactTyperequests.ReadRequest
Post/api/modules/report-contacthandlers.Repo.ReportContact-
Post/api/modules/update-calenderhandlers.Repo.UpdateCalenderCalenderRequest.CalendarEventUpdateRequest
Post/api/modules/update-calender-statushandlers.Repo.UpdateCalenderStatusCalenderRequest.CalendarStatusUpdateRequest
Post/api/modules/update-calender-vehiclehandlers.Repo.UpdateVehicletoCalenderCalenderRequest.CalendarSetVehicleRequest
Post/api/modules/update-contacthandlers.Repo.UpdateContactContactRequest.ContactUpdateRequest
Post/api/modules/update-contact-categoryhandlers.Repo.UpdateContactCategoryContactRequest.ContactCategoryUpdateRequest
Post/api/modules/update-date-calenderhandlers.Repo.UpdateDateCalenderCalenderRequest.CalendarDateEventUpdateRequest

Request Example: CalenderRequest.CalenderEventCreateRequest

{ "name": "string", "description": "string", "customer_id": 0, "started_at": 0, "finished_at": 0, "invited_email": [ "string" ], "is_all_day": true, "is_added_meeting": true, "meet_platform_id": 0, "meet_location": "string", "is_public": true, "is_need_vehicle": true, "master_id": 0 }

Fields:

FieldTypeRequired
namestringno
descriptionstringno
customer_idint64no
started_atint64no
finished_atint64no
invited_email*[]stringno
is_all_dayboolno
is_added_meetingboolno
meet_platform_idint64no
meet_locationstringno
is_publicboolno
is_need_vehicleboolno
master_idint64no

Request Example: CalenderRequest.CalenderMemberCreateRequest

{ "uuid": "string", "name": "string", "surname": "string", "mobile_phone_country": "string", "mobile_phone_area": "string", "mobile_phone": "string", "identification_number": "string", "birthday": "string", "birthday_string": "string", "consent_given_check": 0, "consent_text": "string", "consent_ip_address": "string", "job_id": 0, "note": "string", "referance_code": "string" }

Fields:

FieldTypeRequired
uuidstringno
namestringno
surnamestringno
mobile_phone_countrystringno
mobile_phone_areastringno
mobile_phonestringno
identification_numberstringno
birthdaystringno
birthday_stringstringno
consent_given_checkintno
consent_textstringno
consent_ip_addressstringno
job_idint64no
notestringno
referance_codestringno

Request Example: ContactRequest.ContactCreateRequest

{ "customer_id": 0, "contact_type": [ 0 ], "company_name": "string", "name": "string", "surname": "string", "country_id": 0, "province_id": 0, "district_id": 0, "email": "string", "phone_country": "string", "phone_area": "string", "phone": "string", "address": "string", "post_code": "string", "contact_title": "string", "identification_number": "string", "birthday_date": 0, "birthday_year": "string" }

Fields:

FieldTypeRequired
customer_idint64no
contact_type*[]intyes
company_namestringno
namestringyes
surnamestringyes
country_idintno
province_idintno
district_idintno
emailstringno
phone_countrystringno
phone_areastringno
phonestringno
addressstringno
post_codestringno
contact_titlestringno
identification_numberstringno
birthday_dateint64no
birthday_yearstringno

Request Example: ContactRequest.ContactCategoryCreateRequest

{ "translation": {} }

Fields:

FieldTypeRequired
translation[]Translationno

Request Example: requests.DeleteRequest

{ "id": 0 }

Fields:

FieldTypeRequired
idintyes

Request Example: ContactRequest.ContactDeleteRequest

{ "id": 0 }

Fields:

FieldTypeRequired
idintyes

Request Example: ContactRequest.ContactCategoryDeleteRequest

{ "id": 0 }

Fields:

FieldTypeRequired
idintno

Request Example: requests.ListRequest

{ "per_page": 0, "page": 0, "sort_column": "string", "sort_order": "string" }

Fields:

FieldTypeRequired
per_pageintyes
pageintyes
sort_columnstringno
sort_orderstringno

Request Example: requests.ReadRequest

{ "id": 0 }

Fields:

FieldTypeRequired
idintyes

Request Example: CalenderRequest.CalendarEventUpdateRequest

{ "id": 0, "name": "string", "description": "string", "customer_id": 0, "started_at": 0, "finished_at": 0, "invited_email": [ "string" ], "is_all_day": true, "is_added_meeting": true, "meet_platform_id": 0, "meet_location": "string", "is_public": true, "is_need_vehicle": true }

Fields:

FieldTypeRequired
idint64no
namestringno
descriptionstringno
customer_idint64no
started_atint64no
finished_atint64no
invited_email*[]stringno
is_all_dayboolno
is_added_meetingboolno
meet_platform_idint64no
meet_locationstringno
is_publicboolno
is_need_vehicleboolno

Request Example: CalenderRequest.CalendarStatusUpdateRequest

{ "id": 0, "status_id": 0 }

Fields:

FieldTypeRequired
idint64no
status_idintno

Request Example: CalenderRequest.CalendarSetVehicleRequest

{ "ids": [ 0 ], "vehicle": "string", "note": "string", "vehicle_status_id": 0, "vehicle_planned_date_at": 0, "vehicle_start_location": {}, "vehicle_target_location": {} }

Fields:

FieldTypeRequired
ids[]int64yes
vehiclestringyes
notestringno
vehicle_status_idintno
vehicle_planned_date_atint64no
vehicle_start_locationStartLocationno
vehicle_target_locationTargetLocationno

Request Example: ContactRequest.ContactUpdateRequest

{ "id": 0, "customer_id": 0, "contact_type": {}, "company_name": "string", "name": "string", "surname": "string", "country_id": 0, "province_id": 0, "district_id": 0, "email": "string", "phone_country": "string", "phone_area": "string", "phone": "string", "address": "string", "post_code": "string", "contact_title": "string", "contact_type_id": 0, "identification_number": "string", "birthday_date": 0, "birthday_year": "string" }

Fields:

FieldTypeRequired
idint64yes
customer_idint64no
contact_type[]*intyes
company_namestringno
namestringyes
surnamestringyes
country_idintno
province_idintno
district_idintno
email*stringno
phone_countrystringno
phone_areastringno
phone*stringno
addressstringno
post_codestringno
contact_titlestringno
contact_type_idintno
identification_numberstringno
birthday_dateint64no
birthday_yearstringno

Request Example: ContactRequest.ContactCategoryUpdateRequest

{ "id": 0, "translation": {}, "is_active": true }

Fields:

FieldTypeRequired
idint64yes
translation[]UpdateTranslationno
is_activeboolno

Request Example: CalenderRequest.CalendarDateEventUpdateRequest

{ "id": 0, "started_at": 0, "finished_at": 0 }

Fields:

FieldTypeRequired
idint64no
started_atint64no
finished_atint64no

Response Examples

Create:

{ "status": "succeeded", "message": "record created successfully", "id": 1 }

Delete:

{ "status": "succeeded", "message": "deleted successfully" }

List:

{ "status": "succeeded", "data": [ ], "totalPage": 1, "currentPage": 1, "perPage": 10 }

Read:

{ "status": "succeeded", "data": { } }

Update:

{ "status": "succeeded", "message": "updated successfully" }

Error (example):

{ "status": "invalid_request", "message": "validation failed", "errors": [ ] }
Last updated on