{"swagger":"2.0","info":{"description":"signaturemanager API documentation","version":"0.0.1","title":"signaturemanager API","contact":{},"license":{}},"host":"signature.magnolia.fr","basePath":"/","tags":[{"name":"signature-request-resource","description":"Signature Request Resource"}],"paths":{"/api/debug":{"get":{"tags":["signature-request-resource"],"summary":"debug","operationId":"debugUsingGET","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SignatureRequestDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/signature-requests":{"get":{"tags":["signature-request-resource"],"summary":"getAllSignatureRequests","operationId":"getAllSignatureRequestsUsingGET","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SignatureRequestDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["signature-request-resource"],"summary":"createSignatureRequest","operationId":"createSignatureRequestUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"transactionRequestDTO","description":"transactionRequestDTO","required":true,"schema":{"$ref":"#/definitions/TransactionRequestDTO"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SignatureRequestDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/signature-requests/by-contract/{idContract}":{"delete":{"tags":["signature-request-resource"],"summary":"deleteSignatureRequestByContractId","operationId":"deleteSignatureRequestByContractIdUsingDELETE","produces":["*/*"],"parameters":[{"name":"idContract","in":"path","description":"idContract","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/api/signature-requests/documents/{transactionId}":{"get":{"tags":["signature-request-resource"],"summary":"getDocuments","operationId":"getDocumentsUsingGET","produces":["*/*"],"parameters":[{"name":"transactionId","in":"path","description":"transactionId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TransactionDocumentDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/signature-requests/{idCustomer}":{"delete":{"tags":["signature-request-resource"],"summary":"deleteSignatureRequestByCustomerId","operationId":"deleteSignatureRequestByCustomerIdUsingDELETE","produces":["*/*"],"parameters":[{"name":"idCustomer","in":"path","description":"idCustomer","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/api/signature-requests/{id}":{"get":{"tags":["signature-request-resource"],"summary":"getSignatureRequest","operationId":"getSignatureRequestUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SignatureRequestDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/api/signature-requests/{id}/{status}":{"get":{"tags":["signature-request-resource"],"summary":"patchSignatureRequest","operationId":"patchSignatureRequestUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"},{"name":"status","in":"path","description":"status","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SignatureRequestDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}}},"definitions":{"CustomerDTO":{"type":"object","required":["id"],"properties":{"cellPhone":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"}},"title":"CustomerDTO"},"DocSignatureFieldDTO":{"type":"object","properties":{"name":{"type":"string"},"page":{"type":"integer","format":"int32"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}},"title":"DocSignatureFieldDTO"},"DocumentDTO":{"type":"object","required":["fileContent","fileName"],"properties":{"contractId":{"type":"string"},"customerId":{"type":"string"},"fileContent":{"type":"string","format":"byte"},"fileName":{"type":"string"},"signatureFields":{"type":"array","items":{"$ref":"#/definitions/DocSignatureFieldDTO"}},"templateId":{"type":"string"},"templateSubType":{"type":"string"},"templateType":{"type":"string"}},"title":"DocumentDTO"},"SignatureRequestDTO":{"type":"object","required":["contractId","customerId","requestDate","source","status","transactionId"],"properties":{"contractId":{"type":"string"},"customerId":{"type":"string"},"fileUrl":{"type":"string"},"id":{"type":"string"},"requestDate":{"type":"string","format":"date"},"signatureDate":{"type":"string","format":"date"},"source":{"type":"string"},"status":{"type":"string","enum":["PREPARING_REQUEST","SIGNATURE_REQUESTED","DOCUMENTS_SIGNED","SIGNATURE_REQUEST_CANCELLED","SIGNATURE_REQUEST_FAILED"]},"transactionId":{"type":"string"}},"title":"SignatureRequestDTO"},"TransactionDocumentDTO":{"type":"object","properties":{"content":{"type":"string","format":"byte"},"fileName":{"type":"string"},"id":{"type":"string"},"metaData":{"type":"object"}},"title":"TransactionDocumentDTO"},"TransactionRequestDTO":{"type":"object","required":["contractId"],"properties":{"contractId":{"type":"string"},"customersDTO":{"type":"array","items":{"$ref":"#/definitions/CustomerDTO"}},"documentsDTO":{"type":"array","items":{"$ref":"#/definitions/DocumentDTO"}},"source":{"type":"string"}},"title":"TransactionRequestDTO"}}}