/API reference//
- Get a notice batch
Submit a new EviNotice
Get a single EviNotice
Query multiple EviNotices
Download all attachments of an EviNotice
Download all affidavits of an EviNotice
Download one EviNotice affidavit
Request an on-demand affidavit
Create a notice batch
Query notice batches (HTTP QUERY method)
Update a notice batch
Delete a notice batch
Set the batch body
Add batch recipients (CSV)
Query batch recipients (HTTP QUERY method)
Delete all batch recipients
Add a batch attachment
List batch attachments
Delete all batch attachments
Download a batch attachment
Delete a batch attachment
Get a notice batch
Retrieves the full state of a batch, including its configured notice template and processing progress.
Sécurité
basicAuth
- Productionhttps://api.evicertia.com/v2/EviNotice/Batches/{BatchId}
- Pre-production / QAhttps://api.ecertia.com/v2/EviNotice/Batches/{BatchId}
curl -i -X GET \
-u '<username>:<password>' \
'https://api.evicertia.com/v2/EviNotice/Batches/{BatchId}'Batch retrieved.
The notice template configured for the batch (the per-notice settings applied to every recipient).
Réponse
{ "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43", "State": "Draft", "Submitter": "string", "SubmitterId": "string", "SiteName": "string", "SiteId": "2ee62ea7-ea8b-4a01-be17-6f02722940c2", "Description": "string", "CreationDate": "2019-08-24T14:15:22Z", "ScheduledFor": "2019-08-24T14:15:22Z", "StartedOn": "2019-08-24T14:15:22Z", "ProcessedOn": "2019-08-24T14:15:22Z", "SubmittedOn": "2019-08-24T14:15:22Z", "InvalidOn": "2019-08-24T14:15:22Z", "LastUpdated": "2019-08-24T14:15:22Z", "TotalCount": 0, "EviNotice": { "Subject": "string", "Body": "string", "IssuerName": "string", "From": "string", "DisableSenderHeader": true, "ReplyTo": "string", "CostCentre": "string", "TimeToLive": 0, "CertificationLevel": "None", "LtaStorage": true, "AffidavitKinds": [ … ], "Language": "string", "AffidavitLanguage": "string", "OnlineRetentionPeriod": 0, "PushNotificationUrl": "http://example.com", "PushNotificationFilter": [ … ], "PushNotificationExtraData": "string", "CommitmentOptions": "Disabled", "CommitmentCommentsAllowed": true, "RejectReasons": [ … ], "AcceptReasons": [ … ], "RequireRejectReason": true, "RequireAcceptReason": true, "DeliveryAppearance": "Certified", "AllowRefusal": true, "OwnerNotificationTemplate": "string", "Channel": "string" }, "BatchPushNotificationUrl": "http://example.com", "SentCount": 0, "FailedCount": 0, "ProgressPercentage": 0.1, "ExtraFields": [ "string" ], "InvalidReason": "string", "CsvId": "5b047477-7a4a-4e84-8bbf-e1f64f3318c7", "Outcome": "string" }