Document

Rota responsável pelo upload de um documento.

SecurityoAuth2ClientCredentials

Request

path Parameters

userId required	string or null
documentTypeId required	integer <int32>

Request Body schema: multipart/form-data

Para envio de ficheiro deve ser feita uma requisição do tipo multipart/form-data com nome da propriedade sendo file. Tipos de ficheiro aceitavel(jpg, png, jpeg,pdf,doc,xls,docx,xlsx,odt,ods).

file	string <binary>

Responses

200

Return a document uploaded

400

Unable to return a document uploaded due to validation error

post/api/v1/users/{userId}/documentTypes/{documentTypeId}/documents

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}
]

Rota responsável pelo upload do documento de uma clínica.

SecurityoAuth2ClientCredentials

Request

path Parameters

clinicId required	integer <int32>
documentTypeId required	integer <int32>

Request Body schema: multipart/form-data

Para envio de ficheiro deve ser feita uma requisição do tipo multipart/form-data com nome da propriedade sendo file. Tipos de ficheiro aceitavel(jpg, png, jpeg,pdf,doc,xls,docx,xlsx,odt,ods).

file	string <binary>

Responses

200

Return a document uploaded

400

Unable to return a document uploaded due to validation error

post/api/v1/clinics/{clinicId}/documentTypes/{documentTypeId}/documents

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}
]

Rota responsável pelo upload do documento de uma solicitação.

SecurityoAuth2ClientCredentials

Request

path Parameters

userId required	string or null
documentTypeId required	integer <int32>
solicitationId required	integer <int32>

Request Body schema: multipart/form-data

Para envio de ficheiro deve ser feita uma requisição do tipo multipart/form-data com nome da propriedade sendo file. Tipos de ficheiro aceitavel(jpg, png, jpeg,pdf,doc,xls,docx,xlsx,odt,ods).

file	string <binary>

Responses

200

Return a document uploaded

400

Unable to return a document uploaded due to validation error

post/api/v1/users/{userId}/solicitations/{solicitationId}/documentTypes/{documentTypeId}/documents

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}
]

Rota responsável por devolver um documento para um usuário

SecurityoAuth2ClientCredentials

Request

path Parameters

userId

required

string or null

Responses

200

Return a document for a user

400

Unable to return a document of user with this id due to validation error

404

No document registered by this user id in the system was found

get/api/v1/users/{userId}/documents

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "string"
}
]

Rota responsável por devolver os documentos de uma solicitação

SecurityoAuth2ClientCredentials

Request

path Parameters

solicitationId

required

integer <int32>

Responses

200

Return a document for a user

400

Unable to return a document of user with this id due to validation error

404

No document registered by this user id in the system was found

get/api/v1/solicitations/{solicitationId}/documents

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "string"
}
]

Rota responsável pela devolução do documento de uma clínica

SecurityoAuth2ClientCredentials

Request

path Parameters

clinicId

required

integer <int32>

Responses

200

Success

400

Bad Request

404

Not Found

get/api/v1/clinics/{clinicId}/documents

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "string"
}
]

Rota responsável por devolver um documento para download

SecurityoAuth2ClientCredentials

Request

path Parameters

documentId

required

integer <int32>

Responses

200

Return a document for download

400

Unable to return a document with this id due to validation error

404

No document registered by this id in the system was found

get/api/v1/documents/{documentId}/download

Response samples

application/json

[{"id": 0,
"name": "string",
"contentType": "string",
"url": "string",
"documentType": {"id": 0,
"type": "string"
},
"createdAt": "string"
}
]

Rota responsável por retornar uma lista de tipos de documentos. Você pode usar parâmetros de consulta para especificar os tipos que deseja

SecurityoAuth2ClientCredentials

Request

query Parameters

types

Array of integers or null <int32>

Responses

200

Return a list of documents types

400

Unable to return a list of documents types due to validation error

404

No documents types registered in the system was found

get/api/v1/documents/documents-types

Response samples

application/json

[{"id": 0,
"type": "string"
}
]

Rota responsável por deletar um documento

SecurityoAuth2ClientCredentials

Request

path Parameters

documentId

required

integer <int32>

Responses

204

Delete a document

400

Unable to delete a document due to validation error

delete/api/v1/documents/{documentId}

Response samples

application/json

{"errors": [ ],
"httpStatus": 500
}

➔ Next to Network