/
EviNoticeAffidavitRequest
EviNoticeAffidavitRequest
This operation allows the generation of a custom Affidavit upon request, which will display the following data.
To use this service, before submitting to the EviNoticeSubmit service, you must specify the AffidavitKind 'OnDemand'.
Request parameters
- Id: EviNotice's identifier (cannot be a default value).
- 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]: If enabled, renderable attachments will be displayed in the Affidavit. This attachments must be flagged as IncludeOnAffidavits when submitting the evidence.
- PushNotificationUrl [optional]: URL to which a POST notification will be made showing the result of the operation.
Example of request
POST https://app.evicertia.com/api/v2/EviNotice/Affidavits/Request HTTP/1.1 Content-Type: application/json Accept: application/json Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX== Host: app.evicertia.com { "Id":"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8", "IncludeBody": true, "IncludeEvents": true, "IncludeAttachments": true "PushNotificationUrl": "https://www.mysite.org/url/to/push", }
In case of successful sending, the identifier allocated to the request (RequestId) that will be included in the notification is returned:
Example of answer
{ "RequestId": "79726a87-000c-1f70-42ac-a3ea149f9438" }
Push notifications
This method allows to report the result when generating the Affidavit to a specific Url provided in the EviNoticeAffidavitRequest web service, thus avoiding the need for performing periodically a query.
Example of push notification answer
{ "Identifier": "84225554-41ed-4864-bc0b-03a7990e93c0", "Kind": "Closed", "Date": "2018-01-22T12:46:32.4830752+01:00", "EvidenceType": "eviNotice", "Site": "pruebas", "Owner": "Pruebas evicertia", "OwnerEmail": "pruebas@evicertia.com", "AdditionalData": {} }
, multiple selections available,