{"swagger":"2.0","info":{"version":"1.0.0","title":"3DFootPrints project API","description":"3DFootPrints project API specification","termsOfService":"","contact":{"name":"","email":"mail@nomail.com","url":""},"license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"}},"host":"3dfootprints.com","basePath":"/api/v1","schemes":["http"],"consumes":["application/json"],"produces":["application/json"],"securityDefinitions":{"token":{"type":"apiKey","name":"token","in":"header"}},"paths":{"/user":{"post":{"description":"Create new or update existing user","security":[{"token":[]}],"parameters":[{"description":"User to add or edit","name":"User","in":"body","required":true,"schema":{"$ref":"#/definitions/UserEdit"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/User"}},"default":{"$ref":"#/responses/Error"}}}},"/user/{id}":{"get":{"description":"Read user information","security":[{"token":[]}],"parameters":[{"description":"User ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/User"}},"default":{"$ref":"#/responses/Error"}}},"delete":{"description":"Delete user","security":[{"token":[]}],"parameters":[{"description":"User ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/user/reset-password":{"get":{"description":"Initiates user password resetting. Is only callable by the user himself. In the end of execution URL to complete the process is sent to user's mailbox","security":[{"token":[]}],"parameters":[],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/user/reset-password/{passwordResetToken}":{"get":{"description":"Reset user password. User can call this API endpoint URL from the email, which should be previously sent to his mailbox","parameters":[{"description":"Password reset token","name":"passwordResetToken","in":"path","required":true,"type":"integer"}],"responses":{"300":{"description":"Performs redirect to a special static website page"},"default":{"$ref":"#/responses/Error"}}}},"/session":{"post":{"description":"New system session creation (sign-in process). Receives attributes required to generate a new user session in the system. On success returns created session details","parameters":[{"description":"User credentials","name":"Credentials","in":"body","required":true,"schema":{"$ref":"#/definitions/UserCredentials"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Session"}},"default":{"$ref":"#/responses/Error"}}},"delete":{"description":"Delete session for current user","security":[{"token":[]}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/sessions/{userId}":{"delete":{"description":"Delete all sessions for a user","security":[{"token":[]}],"parameters":[{"description":"User ID","name":"userId","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/clinic":{"post":{"description":"Create new or update existing clinic","security":[{"token":[]}],"parameters":[{"description":"Clinic to add or edit","name":"Clinic","in":"body","required":true,"schema":{"$ref":"#/definitions/ClinicEdit"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Clinic"}},"default":{"$ref":"#/responses/Error"}}}},"/clinic/{id}":{"get":{"description":"Read clinic information","security":[{"token":[]}],"parameters":[{"description":"Clinic ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Clinic"}},"default":{"$ref":"#/responses/Error"}}},"delete":{"description":"Delete clinic","security":[{"token":[]}],"parameters":[{"description":"Clinic ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/doctor":{"post":{"description":"Create new or update existing doctor","security":[{"token":[]}],"parameters":[{"description":"Doctor to add or edit","name":"Doctor","in":"body","required":true,"schema":{"$ref":"#/definitions/DoctorEdit"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Doctor"}},"default":{"$ref":"#/responses/Error"}}}},"/doctor/{userId}":{"get":{"description":"Read doctor information","security":[{"token":[]}],"parameters":[{"description":"User ID","name":"userId","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Doctor"}},"default":{"$ref":"#/responses/Error"}}}},"/patient":{"post":{"description":"Create new or update existing patient","security":[{"token":[]}],"parameters":[{"description":"Patient to add or edit","name":"Doctor","in":"body","required":true,"schema":{"$ref":"#/definitions/PatientEdit"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Patient"}},"default":{"$ref":"#/responses/Error"}}}},"/patient/{id}":{"get":{"description":"Read patient information","security":[{"token":[]}],"parameters":[{"description":"Patient ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Patient"}},"default":{"$ref":"#/responses/Error"}}},"delete":{"description":"Delete patient","security":[{"token":[]}],"parameters":[{"description":"Patient ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/diagnosis":{"post":{"description":"Create new or update existing diagnosis","security":[{"token":[]}],"parameters":[{"description":"Disagnosis to add or edit","name":"Disagnosis","in":"body","required":true,"schema":{"$ref":"#/definitions/DiagnosisEdit"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Diagnosis"}},"default":{"$ref":"#/responses/Error"}}}},"/diagnosis/{id}":{"get":{"description":"Read diagnosis information","security":[{"token":[]}],"parameters":[{"description":"Diagnosis ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Diagnosis"}},"default":{"$ref":"#/responses/Error"}}},"delete":{"description":"Delete diagnosis","security":[{"token":[]}],"parameters":[{"description":"Diagnosis ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}},"/print-model":{"post":{"description":"Create new or update existing print model","security":[{"token":[]}],"parameters":[{"description":"Print model to add or edit","name":"PrintModel","in":"body","required":true,"schema":{"$ref":"#/definitions/PrintModelEdit"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PrintModel"}},"default":{"$ref":"#/responses/Error"}}}},"/print-model/{id}":{"get":{"description":"Read print model information","security":[{"token":[]}],"parameters":[{"description":"Print model ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PrintModel"}},"default":{"$ref":"#/responses/Error"}}},"delete":{"description":"Delete print model","security":[{"token":[]}],"parameters":[{"description":"Print model ID","name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"default":{"$ref":"#/responses/Error"}}}}},"definitions":{"User":{"description":"User profile information","type":"object","properties":{"id":{"type":"integer"},"email":{"description":"Email, which also serves as username","type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"type":{"$ref":"#/definitions/UserType"},"status":{"$ref":"#/definitions/UserStatus"},"timezone":{"type":"integer"},"createdAt":{"description":"UTC timestamp","type":"integer"},"updatedAt":{"description":"UTC timestamp","type":"integer"}}},"UserEdit":{"description":"Object to create or update user information","type":"object","properties":{"id":{"description":"ID","type":"integer"},"email":{"description":"Email","type":"string"},"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last Name","type":"string"},"type":{"$ref":"#/definitions/UserType"},"status":{"$ref":"#/definitions/UserStatus"}}},"UserType":{"description":"User type enumeration [1 - admin, 2 - doctor]","type":"integer","enum":[1,2]},"UserStatus":{"description":"User status enumeration [0 - deleted, 1 - active, 2 - inactive]","type":"integer","enum":[0,1,2]},"UserCredentials":{"description":"Username and password, used for authorization","type":"object","properties":{"username":{"description":"Username","type":"string"},"password":{"description":"Password","type":"string","format":"password"}}},"Session":{"description":"Session attributes","type":"object","properties":{"userId":{"description":"User ID","type":"integer"},"expires":{"description":"UTC timestamp of session expiration","type":"integer"},"token":{"description":"Token to authenticate further requests to API. It equals session ID","type":"string"}}},"Clinic":{"description":"Clinic information","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/definitions/ClinicStatus"},"address":{"type":"string"}}},"ClinicEdit":{"description":"Object to create or update clinic information","type":"object","properties":{"id":{"description":"ID","type":"integer"},"name":{"description":"Name","type":"string"},"status":{"$ref":"#/definitions/ClinicStatus"},"address":{"description":"Address","type":"string"}}},"ClinicStatus":{"description":"Clinic status enumeration [0 - deleted, 1 - active]","type":"integer","enum":[0,1]},"Doctor":{"description":"Doctor information","type":"object","properties":{"userId":{"type":"integer"},"clinicId":{"type":"integer"},"status":{"$ref":"#/definitions/UserStatus"},"title":{"description":"Title","type":"string"}}},"DoctorEdit":{"description":"Object to create or update doctor information","type":"object","properties":{"userId":{"description":"User ID","type":"integer"},"clinicId":{"description":"Clinic ID","type":"integer"},"status":{"$ref":"#/definitions/UserStatus"},"title":{"description":"Title","type":"string"}}},"Patient":{"description":"Patient information","type":"object","properties":{"id":{"description":"Patient ID","type":"integer"},"doctorId":{"description":"Doctor ID","type":"integer"},"firstName":{"type":"string"},"lastName":{"type":"string"},"status":{"$ref":"#/definitions/PatientStatus"},"dateOfBirth":{"type":"string","format":"date"},"gender":{"$ref":"#/definitions/Gender"},"weight":{"type":"number","format":"float"}}},"PatientEdit":{"description":"Object to create or update patient information","type":"object","properties":{"id":{"description":"Patient ID","type":"integer"},"doctorId":{"description":"Doctor ID","type":"integer"},"firstName":{"type":"string"},"lastName":{"type":"string"},"status":{"$ref":"#/definitions/PatientStatus"},"dateOfBirth":{"type":"string","format":"date"},"gender":{"$ref":"#/definitions/Gender"},"weight":{"type":"number","format":"float"}}},"PatientStatus":{"description":"Patient status enumeration [0 - deleted, 1 - active, 2 - inactive]","type":"integer","enum":[0,1,2]},"Gender":{"description":"Gender enumeration [1 - man, 2 - woman]","type":"integer","enum":[1,2]},"Diagnosis":{"description":"Diagnosis information","type":"object","properties":{"id":{"description":"Diagnosis ID","type":"integer"},"patientId":{"description":"Patient ID","type":"integer"},"status":{"$ref":"#/definitions/DiagnosisStatus"},"createdAt":{"description":"UTC timestamp","type":"integer"},"updatedAt":{"description":"UTC timestamp","type":"integer"},"shoeSize":{"type":"number","format":"float"},"shoeWidth":{"type":"number","format":"float"},"heelHeight":{"type":"number","format":"float"},"shape":{"type":"string"},"flange":{"type":"string"},"heelCup":{"type":"string"}}},"DiagnosisEdit":{"description":"Object to create or update diagnosis information","type":"object","properties":{"id":{"description":"Diagnosis ID","type":"integer"},"patientId":{"description":"Patient ID","type":"integer"},"status":{"$ref":"#/definitions/DiagnosisStatus"},"shoeSize":{"type":"number","format":"float"},"shoeWidth":{"type":"number","format":"float"},"heelHeight":{"type":"number","format":"float"},"shape":{"type":"string"},"flange":{"type":"string"},"heelCup":{"type":"string"}}},"DiagnosisStatus":{"description":"Diagnosis status enumeration [0 - deleted, 1 - active, 2 - completed]","type":"integer","enum":[0,1,2]},"PrintModel":{"description":"Print model information","type":"object","properties":{"id":{"description":"Print model ID","type":"integer"},"patientId":{"description":"Patient ID","type":"integer"},"diagnosisId":{"description":"Diagnosis ID","type":"integer"},"data":{"description":"Print model binary content","type":"string","format":"binary"}}},"PrintModelEdit":{"description":"Object to create or update print model information","type":"object","properties":{"id":{"description":"Print model ID","type":"integer"},"patientId":{"description":"Patient ID","type":"integer"},"diagnosisId":{"description":"Diagnosis ID","type":"integer"},"data":{"description":"Print model binary content","type":"string","format":"binary"}}},"Error":{"description":"Business logic error information","type":"object","properties":{"error":{"type":"string"}}}},"responses":{"Error":{"description":"Unexpected Error","schema":{"$ref":"#/definitions/Error"}}}}