Skip to end of banner
Go to start of banner

EviMailAffidavitRequest

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This operation allows the generation of a custom affidavit upon request, which will display the following data.

NOTE: To use this service, before submitting to the EviMailSubmit service, 'AffidavitsOnDemandEnabled: true' had to be indicated within the node Options


  • UniqueId: Unique identifier of evidence.
  • PushUrl [optional]: URL to which a POST notification will be made showing the result of the operation.
  • IncludeBody [optional]: If enabled, the body of the message will be displayed in the affidavit.
  • IncludeEvents [optional]: If enabled, detailed information regarding the events will be displayed in the affidavit.
  • IncludeAttachments [optional]: List of attachments that will be displayed in the affidavit. Attachments must be flagged as IncludeOnAffidavits when submitting the evidence.



Example of request in JSON
POST https://app.evicertia.com/api/EviMail/AffidavitRequest HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.evicertia.com

{
	"UniqueId":"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8",
	"PushUrl":"http://www.mysite.org/url/to/push",
	"IncludeBody":"true",
	"IncludeEvents":"true",
	"IncludeAttachments":["ff45a214-e773-4bd5-9b8d-a8ef00fd80f8"]
}



In case of successful sending, the identifier allocated to the request (RequestId) that will be included in the notification is returned:

Example of answer in JSON
{
	"requestId": "79726a87000c1f7042aca3ea149f9438"
}



Push notifications

This method allows to report the result when generating the affidavit to a specific Url provided in the EviMailAffidavitRequest web service, thus avoiding the need for performing periodically a query.


Example of push notification answer:
{
	"EventIdentifier": "1234",
	"EvidenceId": "2aca3ea149f943879726a87000c1f704",
	"EvidenceType": "eviMail",
	"EventType": "EviMailAffidavitOnDemandGenerated",
	"EventDate": "2018-01-22T12:46:32.4830752+01:00",
	"Site": "pruebas",
	"Owner": "Pruebas evicertia",
	"OwnerEmail": "pruebas@evicertia.com",
	"AdditionalData": {
		"RequestUniqueId": "79726a87000c1f7042aca3ea149f9438",
		"AffidavitUniqueId": "000c1f7042aca3ea149f943879726a87",
		"AffidavitBytesLength": "1234",
		"AffidavitName": "Certification of certified e-mail (on request)",
		"Success": "true",
		"ErrorMessage": ""
	}
}


  • No labels