Passer au contenu

Get a notice batch

Requête

Retrieves the full state of a batch, including its configured notice template and processing progress.

Sécurité
basicAuth
Chemin
BatchIdstring, (uuid)obligatoire

The UUID of the batch, as returned at creation.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviNotice/Batches/{BatchId}'

Réponses

Batch retrieved.

Corpsapplication/json
Idstring, (uuid)
Statestring
Enum:"Draft""Submitted""Scheduled""Processing""Processed""Invalid""Failed"
Submitterstring

Display name of the user who created the batch.

SubmitterIdstring
SiteNamestring
SiteIdstring, (uuid)
Descriptionstring
CreationDatestring, (date-time)
ScheduledForstring, (date-time)

Scheduled execution date and time in UTC.

StartedOnstring, (date-time)
ProcessedOnstring, (date-time)
SubmittedOnstring, (date-time)
InvalidOnstring, (date-time)
LastUpdatedstring, (date-time)
TotalCountinteger

Total number of recipients in the batch.

EviNoticeobject(EviNoticeBatchTemplate)

The notice template configured for the batch (the per-notice settings applied to every recipient).

BatchPushNotificationUrlstring, (uri)
SentCountinteger

Number of notices dispatched so far.

FailedCountinteger

Number of notices that failed.

ProgressPercentagenumber, (float)

Processing progress as a percentage (0–100).

ExtraFieldsArray of strings

Names of the custom recipient columns detected in the uploaded CSV.

InvalidReasonstring

Explanation when the batch is in the Invalid state.

CsvIdstring, (uuid)
Outcomestring
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" }