Datos de transacción 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 obtener más información, consulte Atributos de documentos.

El siguiente código muestra cómo editar el objeto DocumentPackage para agregar atributos de paquete.

  DocumentPackage superDuperPackage = PackageBuilder.NewPackageNamed("Policy " + DateTime.Now).DescribedAs("This is a package created using the e-SignLive SDK").ExpiresOn(DateTime.Now.AddMonths(1)).WithEmailMessage("This message should be delivered to all signers").WithSigner(SignerBuilder.NewSignerWithEmail("[email protected]").WithCustomId("Client1").WithFirstName("John").WithLastName("Smith").WithTitle("Managing Director").WithCompany("Acme Inc.")).WithDocument(DocumentBuilder.NewDocumentNamed("First Document").FromFile(@ "C:/Users/hhaidary/Desktop/pdf/doc1.pdf").WithSignature(SignatureBuilder.SignatureFor("[email protected]").OnPage(0).WithField(FieldBuilder.CheckBox().OnPage(0).AtPosition(400, 200).WithValue("x")).AtPosition(100, 100))).WithAttributes(new DocumentPackageAttributesBuilder().WithAttribute("First Name", "Bill").WithAttribute("Last Name", "Johnson").WithAttribute("Signing Order", "1").Build()).Build();  

Recuperar sus atributos

Los atributos se establecen en el nivel de transacción. Para recuperar sus atributos, primero tendrá que recuperar su transacción. A continuación, con su objeto DocumentPackage, utilice los métodos getAttributes() y getContents() para recuperar sus atributos. Los atributos se le devolverán como un mapa.

  DocumentPackage retrievedPackage = eslClient.GetPackage(packageId);
IDictionary < string, Object > attributes = retrievedPackage.Attributes.Contents;
foreach(KeyValuePair < string, Object > entry in attributes) {
	Debug.WriteLine(entry.Key + ": " + entry.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 obtener más información, consulte Atributos de documentos.

El siguiente código muestra cómo editar el objeto DocumentPackage para agregar atributos de paquete.

Solicitud HTTP

POST /api/packages

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" {
	"documents": [{
		"approvals": [{
			"id": "ExampleSignatureId",
			"role": "Signer1",
			"fields": [{
				"page": 0,
				"top": 200,
				"subtype": "LABEL",
				"height": 50,
				"left": 100,
				"width": 200,
				"id": "myLabelField",
				"type": "INPUT",
				"value": "Example label field value"
			}, {
				"page": 0,
				"top": 100,
				"subtype": "FULLNAME",
				"height": 50,
				"left": 100,
				"width": 200,
				"type": "SIGNATURE",
				"name": "ExampleSignatureId"
			}],
			"name": ""
		}],
		"id": "sample-contract",
		"name": "Test Document"
	}],
	"status": "DRAFT",
	"type": "PACKAGE",
	"roles": [{
		"id": "Signer1",
		"type": "SIGNER",
		"signers": [{
			"email": "[email protected]",
			"firstName": "John",
			"lastName": "Smith",
			"id": "Signer1"
		}],
		"name": "Signer1"
	}],
	"name": "Example Package",
	"data": {
		"First Name": "Bill",
		"Last Name": "Johnson",
		"Signing Order": "1"
	}
}-- -- --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=" }  

Los atributos se establecen en el nivel de paquete. Por lo tanto, necesitará obtener su paquete JSON para recuperar sus atributos de paquete.

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

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.

El primer paso es crear un paquete. Si necesita una comparación con el procedimiento básico de creación de objetos o si es la primera vez que crea una transacción, consulte Crear y enviar una transacción.

Una vez que haya recuperado su ID de paquete, utilice la siguiente función encapsulada para entregar el ID del paquete y los atributos en un mapa como parámetros.

  public void addAttributes(String packageId, Map<String, Object> attributes)  

Recuperar sus atributos

Utilice el siguiente código para recuperar sus atributos a nivel de paquete. Estos atributos se entregan como un mapa, utilizando el PackageID.

  public Map<String, Object> getAttributes(String packageId)  

Resultados

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