Through this API a document management document is created (Guarantee or Document) and associated with an inhouse personnel.
EndPoint
https://app.fracttal.com/api/personnel_document_management
Method POST
Input Parameters in the Body
Parameter | Type of field | Required | Description |
code | Text | Yes | Inhouse Personnel code |
name | Text | Yes | Warranty name |
description | Text | Optional | Warranty Description |
group_description | Text | Optional | Guarantee group. If an existing group will be associated, the name must be sent as it’s created in Fracttal, in case a group with the sent description is not found, a new one will be created |
version | Text | Optional | Document version |
valid_from | Date | Optional | Validity start date |
valid_until | Date | Optional | End date of validity |
warranty | Boolean | Optional | Send true if it is guarantee, false otherwise |
iso_code | Text | Optional | ISO code of the document |
author | Text | Optional | Author |
Note: Send the mandatory fields and the parameters with the additional values that you want to insert.
Output parameters
Parameter | Type of field | Description |
success | Boolean | True if the insert was successful or false otherwise |
message | Text | 200 if it was successful |
data | Text | Json with the documents details inserted |
total | Number | Number of inserted documents. By default 1 |
Example:
Petition: (POST) https://app.fracttal.com/api/items_document_management
Body
{
"code":"7845123",
"name":"Certificación trabajo en alturas",
"description":"Certificación trabajo en alturas realizada por la empresa ABC",
"group_description":"Certificación",
"version":"0.001",
"valid_from":"2019-10-27",
"valid_until":"2021-10-27",
"warranty":true,
"iso_code":"ISO 39001",
"author":"ISO"
} Example Response:
{
"success": true,
"message": "200",
"data": [
{
"id_company": 69,
"id_group_attached": 5,
"groups_attached_description": "Certificación",
"description": "Certificación trabajo en alturas realizada por la empresa ABC",
"name": "Certificación trabajo en alturas",
"version": "0.001",
"valid_from": "2019-10-27T00:00:00+00:00",
"valid_through": "2021-10-27T00:00:00+00:00",
"author": "ISO",
"code_iso": "ISO 39001",
"id_personnel": 7,
"id_attached": 11,
"id": 3,
"is_warranty": true,
"status": true,
"personnel_name": "Fracttal SPA",
"code": "7845123",
"email": "[email protected]"
}
],
"total": 1
}