logo

Verification notes service

Retrieves verficiation notes

Get verification notes data

Retrieves verification notes data.

Access to this method is authorized by the Get verification notes operation.

At least one parameter must be provided.

Securityips_token
Request
query Parameters
LastEventGmtDate
string <date-time>

Verification notes with last event on or after this date and time, in format YYYY-MM-DD HH:MM:SS.mmm

vnFId
string <= 20 characters

The ID of the Verification Note

consignmentFId
string <= 12 characters ^[A-z0-9]{12}$

Consignment identifier. Format must be compliant with S32 UPU standard

originOperators
string

A list of operator codes the mail orgininated from for which verification notes are retrieved, in format [OP1,OP2]

originOffices
string

A list of office codes the mail orgininated from for which verification notes are retrieved, in format [OFFIC1,OFFIC2]

destinationOperators
string

A list of operator codes the mail was sent to for which verification notes are retrieved, in format [OP1,OP2]

destinationOffices
string

A list of office codes the mail was sent to for which verification notes are retrieved, in format [OFFIC1,OFFIC2]

MailClass
string

Filter verification notes that apply only to the provided mail class

Enum: "U" "C" "E"
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/VerificationNotesService.svc/rest/VerificationNotes
Response samples
application/json
{
  • "VerificationNotes": [
    ]
}