Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Los campos permiten colocar datos adicionales en un documento en el momento de la firma. Al igual que los campos de firma, los campos sin firma pueden colocarse en cualquier lugar del documento. No obstante, cada campo está vinculado a una firma concreta. Solo el firmante de esa firma puede asignar o cambiar el valor del campo. Sin embargo, una vez hecha la firma, nadie puede cambiar el valor del campo.
No se pueden agregar campos a: (1) documentos que son de tipo Aceptar únicamente; (2) el formulario de Consentimiento electrónico; (3) los documentos de una transacción accesible.
Agregar un campo a un documento
Para agregar un campo en un documento, primero deberá crear su objeto Field utilizando el OneSpan Sign FieldBuilder. Use el siguiente código para hacerlo:
Field field = FieldBuilder.label() .withId(new FieldId("myLabelField")) .withValue("Example label field value") .atPosition(100, 200) .onPage(0) .build();
Entonces, utilizando el OneSpan SignApprovalService, agregue su campo a su documento. Utilice el objeto Field , PackageID, SignatureID y documentID como parámetros. Use el siguiente código para hacerlo:
String labelFieldId = client.getApprovalService().addField(packageId, "sample-contract", signatureid, field);
Actualizar un campo en un documento
Es importante tener en cuenta que al actualizar un campo, el nuevo objeto Campo debe tener el mismo id que el campo que desea actualizar.
Use el siguiente código para hacerlo:
Field updatedField = FieldBuilder.signatureDate() .onPage(0) .withId(new FieldId("myLabelField")) .atPosition(100, 200) .build(); client.getApprovalService().updateField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), updatedField);
Borrar un campo de un documento
Para eliminar un campo, utilice el OneSpan SignApprovalService. Utilice el objeto Field , PackageID, SignatureID y documentID como parámetros. Use el siguiente código para hacerlo:
client.getApprovalService().deleteField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), new FieldId("myLabelField"));
Resultados
Una vez que haya ejecutado su código, sus campos aparecerán en los documentos de su transacción.
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Los campos permiten colocar datos adicionales en un documento en el momento de la firma. Al igual que los campos de firma, los campos sin firma pueden colocarse en cualquier lugar del documento. No obstante, cada campo está vinculado a una firma concreta. Solo el firmante de esa firma puede asignar o cambiar el valor del campo. Sin embargo, una vez hecha la firma, nadie puede cambiar el valor del campo.
No se pueden agregar campos a: (1) documentos que son de tipo Aceptar únicamente; (2) el formulario de Consentimiento electrónico; (3) los documentos de una transacción accesible.
Agregar un campo a un documento
Para agregar un campo en un documento, primero deberá crear su objeto Field utilizando OneSpan Sign FieldBuilder, como se muestra a continuación.
Field field = FieldBuilder.Label() .WithId("myLabelField") .WithValue("Example label field value") .AtPosition(100, 200) .OnPage(0) .Build();
Entonces, utilizando el OneSpan SignApprovalService, agregue su campo a su documento. Utilice el objeto Field , PackageID, SignatureID y documentID como parámetros. Use el siguiente código para hacerlo:
string labelFieldId = client.ApprovalService.AddField(packageId, "sample-contract", signatureid, field);
Actualizar un campo en un documento
Es importante tener en cuenta que al actualizar un campo, el nuevo objeto Campo debe tener el mismo id que el campo que desea actualizar.
Use el siguiente código para hacerlo:
Field updatedField = FieldBuilder.SignatureDate() .OnPage(0) .WithId("myLabelField") .AtPosition(100, 200) .Build(); client.ApprovalService.ModifyField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), updatedField);
Borrar un campo de un documento
Para eliminar un campo, utilice el OneSpan SignApprovalService. Utilice el objeto Field , PackageID, SignatureID y documentID como parámetros. Use el siguiente código para hacerlo:
client.ApprovalService.DeleteField(packageId, "sample-contract", new SignatureId("ExampleSignatureId"), "myLabelField");
Resultados
Una vez que haya ejecutado su código, sus campos aparecerán en los documentos de su transacción.
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Los campos permiten colocar datos adicionales en un documento en el momento de la firma. Al igual que los campos de firma, los campos sin firma pueden colocarse en cualquier lugar del documento. No obstante, cada campo está vinculado a una firma concreta. Solo el firmante de esa firma puede asignar o cambiar el valor del campo. Sin embargo, una vez hecha la firma, nadie puede cambiar el valor del campo.
No se pueden agregar campos a: (1) documentos que son de tipo Aceptar únicamente; (2) el formulario de Consentimiento electrónico; (3) los documentos de una transacción accesible.
Agregar un campo a un documento
La siguiente solicitud de ejemplo le muestra cómo agregar un campo a un documento existente:
Solicitud HTTP
POST /api/packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields
Encabezados HTTP
Accept: application/json; esl-api-version=11.21 Content-Type: application/json Authorization: Basic api_key
Carga útil de solicitud
{ "name":"Signer Name", "top":500, "left":300, "width":100, "height":30, "page":0, "type":"INPUT", "value":null, "binding":"{signer.name}", "subtype":"LABEL" }
Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente.
Carga útil de respuesta
{ "binding": "{signer.name}", "validation": null, "id": "BsZv3XvmpsMH", "page": 0, "data": null, "subtype": "LABEL", "top": 500, "height": 30, "extractAnchor": null, "width": 100, "extract": false, "left": 300, "type": "INPUT", "value": "{signer.name}", "name": "Signer Name" } Consulte la Nota de versión 10.6.1 para conocer el motivo por el que esl-api-version se encuentra en el encabezado de la solicitud. Si desea un ejemplo de creación de un paquete de documentos básico para su comparación, puede seguir esta guía.
Actualizar un campo en un documento
Es importante tener en cuenta que al actualizar un campo, el nuevo objeto Campo debe tener el mismo id que el campo que desea actualizar.
Para actualizar un campo, deberá realizar una solicitud PUT a:
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/fields/{fieldId} Con los parámetros de campo actualizados:
{ "id": "myLabelField", "top": 200, "left": 100, "width": 250, "height": 50, "page": 0, "type": "INPUT", "binding": "{approval.signed}", "subtype": "LABEL" } Borrar un campo de un documento
La eliminación de un campo se realiza mediante una solicitud de ELIMINAR a:
https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}/approvals/{signatureId}/fields/{fieldId} Resultados
Una vez que haya ejecutado su código, sus campos aparecerán en los documentos de su transacción.
Tabla de carga útil de solicitud
| Propiedad | Tipo | Editable | Obligatorio | Predeterminado | Valores de ejemplo |
|---|---|---|---|---|---|
| name | string | Sí | No | n/a | Nombre del firmante |
| top | integer | Sí | No | 0 | 500 |
| left | integer | Sí | No | 0 | 300 |
| width | integer | Sí | No | 200 | 100 |
| height | integer | Sí | No | 50 | 30 |
| page | integer | Sí | No | 0 | 0 / 1 / 2 ... |
| type | string | Sí | No | n/a | FIRMA / ENTRADA |
| value | string | Sí | No | null | STU BANK |
| subtype | string | Sí | No | n/a | NOMBRE COMPLETO / INICIALES / CAPTURA / ETIQUETA / CAMPO DE TEXTO / ÁREA DE TEXTO / CASILLA DE VERIFICACIÓN / RADIO / LISTA |
| binding | string | Sí | No | null | {approval.signed} / {signer.title} / {signer.name} / {signer.company} |
Para descargar la muestra de código completa, consulte nuestro sitio Code Share.
Los campos permiten colocar datos adicionales en un documento en el momento de la firma. Al igual que los campos de firma, los campos sin firma pueden colocarse en cualquier lugar del documento. No obstante, cada campo está vinculado a una firma concreta. Solo el firmante de esa firma puede asignar o cambiar el valor del campo. Sin embargo, una vez hecha la firma, nadie puede cambiar el valor del campo.
No se pueden agregar campos a: (1) documentos que son de tipo Aceptar únicamente; (2) el formulario de Consentimiento electrónico; (3) los documentos de una transacción accesible.
Agregar un campo a un documento
Para agregar un campo en un documento, primero deberá construir su objeto Field como se muestra a continuación.
//create field to an existing approval ESignLiveAPIObjects.Field label_field = new ESignLiveAPIObjects.Field(); label_field.id = 'label_field'; label_field.type = 'INPUT'; label_field.subtype = 'LABEL'; label_field.value = 'old label value'; label_field.page = 0; label_field.top = 100.0; label_field.left = 50.0; label_field.width = 150.0; label_field.height = 50.0;
Entonces, utilizando la función addField, agregue su campo al documento. Utilice el objeto Field , PackageID, ApprovalID y documentID como parámetros. Use el siguiente código para hacerlo:
//String packageId, String documentId, String approvalId, ESignLiveAPIObjects.Field fieldToCreate String label_field_response = sdk.addField('yjn7R9GyKU_BRhUjvLrWFp5vUEA=','f3e381eec45b4df851bd28087ad12104c620814bccca6b76','8ELNXeOxMHsD',label_field); label_field = (ESignLiveAPIObjects.Field)JSON.deserialize(label_field_response, ESignLiveAPIObjects.Field.class);
Actualizar un campo en un documento
Es importante tener en cuenta que al actualizar un campo, el nuevo objeto Campo debe tener el mismo id que el campo que desea actualizar.
Use el siguiente código para hacerlo:
//update field //String packageId, String documentId, String approvalId, String fieldId, ESignLiveAPIObjects.Field fieldToUpdate label_field.value = 'changed label value'; sdk.updateField('yjn7R9GyKU_BRhUjvLrWFp5vUEA=','f3e381eec45b4df851bd28087ad12104c620814bccca6b76','8ELNXeOxMHsD',label_field.id,label_field);
Borrar un campo de un documento
Para eliminar un campo, utilice el OneSpan SignApprovalService. Utilice el objeto Field , PackageID, SignatureID y documentID como parámetros. Use el siguiente código para hacerlo:
//delete field //String packageId, String documentId, String approvalId, String fieldId sdk.deleteField('yjn7R9GyKU_BRhUjvLrWFp5vUEA=','f3e381eec45b4df851bd28087ad12104c620814bccca6b76','8ELNXeOxMHsD',label_field.id);
Resultados
Una vez que haya ejecutado su código, sus campos aparecerán en los documentos de su transacción.