Datos de documento personalizados

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Los atributos de documento son datos personalizados relacionados con un documento de una transacción o con todos los datos de una transacción. Estos datos no son interpretados por OneSpan Sign. Como tales, los usuarios de estos datos son libres de almacenar e interpretar los datos que deseen.

Los datos personalizados también pueden aplicarse a nivel de transacción. Para más información, consulte Atributos de paquete.

El siguiente ejemplo de código ilustra la forma más sencilla de crear un paquete con atributos de documento personalizados. Este ejemplo ilustra cómo crear atributos personalizados con las claves Department y Employee. Los datos de atributos personalizados se construyen como un mapa.

 DocumentPackage superDuperPackage = PackageBuilder.NewPackageNamed(PackageName).DescribedAs("This is a package created using the OneSpan Sign SDK").WithSigner(SignerBuilder.NewSignerWithEmail(email1).WithCustomId("Client1").WithFirstName("John").WithLastName("Smith").WithTitle("Managing Director").WithCompany("Acme Inc.")).WithDocument(DocumentBuilder.NewDocumentNamed(DOCUMENT_NAME).FromStream(fileStream1, DocumentType.PDF).WithSignature(SignatureBuilder.SignatureFor(email1).OnPage(0).AtPosition(100, 100)).WithData(DocumentAttributesBuilder.NewDocumentAttributes().AddAttribute("Department", "1806").AddAttribute("Employee", "135526"))).Build();

Recuperar sus atributos

Para recuperar estos atributos, utilice el siguiente código:

DocumentPackage pkg = eslClient.GetPackage(packageId);
Document doc = pkg.GetDocument("sample doc");
IDictionary < string, object > attributes = doc.Data;
foreach(var attribute in attributes) {
	Debug.WriteLine("Key : " + attribute.Key + " Value : " + attribute.Value);
}

Resultados

A continuación, se muestra un ejemplo de lo que puede ver una vez que haya ejecutado su código.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Los atributos de documento son datos personalizados relacionados con un documento de una transacción o con todos los datos de una transacción. Estos datos no son interpretados por OneSpan Sign. Como tales, los usuarios de estos datos son libres de almacenar e interpretar los datos que deseen.

Los datos personalizados también pueden aplicarse a nivel de transacción. Para más información, consulte Atributos de paquete.

El siguiente ejemplo de código ilustra la forma más sencilla de crear un paquete con atributos de documento personalizados. Este ejemplo ilustra cómo crear atributos personalizados con las claves Department y Employee. Los datos de atributos personalizados se construyen como un mapa.

Solicitud HTTP

Encabezados HTTP

Accept: application/json   
Content-Type: multipart/form-data   
Authorization: Basic api_key 

Carga útil de solicitud

 ------WebKitFormBoundary1bNO60n7FqP5WO4t   Content-Disposition: form-data; name="file"; filename="testDocumentExtraction.pdf"   Content-Type: application/pdf   %PDF-1.5   %µµµµ   1 0 obj   <>>>   endobj....   ------WebKitFormBoundary1bNO60n7FqP5WO4t   Content-Disposition: form-data; name="payload"   {   "autocomplete": true,   "documents": [   {   "approvals": [   {   "fields": [   {   "extract": false,   "height": 50,   "left": 100,   "page": 0,   "subtype": "FULLNAME",   "top": 100,   "type": "SIGNATURE",   "width": 200   }   ],   "role": "Client1"   }   ],   "data": {   "Department": "1806",   "Employee": "135526"   },   "name": "sample doc"   }   ],   "name": "Document Attributes Example",   "roles": [   {   "id": "Client1",   "name": "Client1",   "signers": [   {   "company": "Acme Inc.",   "email": "[email protected]",   "firstName": "John",   "id": "Client1",   "lastName": "Smith",   "title": "Managing Director"   }   ]   }   ],   "trashed": false,   "type": "PACKAGE",   "visibility": "ACCOUNT"   }   ------WebKitFormBoundary1bNO60n7FqP5WO4t-- 

Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente.

Carga útil de respuesta

 {   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   } 

Si desea recuperar sus atributos en una etapa posterior, puede hacerlo simplemente recuperando su documento JSON:

GET https://sandbox.esignlive.com/api/packages/{packageId}/documents/{documentId}

Luego, recorra en bucle la propiedad de campo data.

Resultados

A continuación, se muestra un ejemplo de lo que puede ver una vez que haya ejecutado su código.

Tabla de carga útil de solicitud