EAD check service

Retreives EAD check information

Perform mail item EAD check

Perform an EAD check on a set of mailitems. IPS will call CDS or GTT to perform the checks.

Access to this method is authorized by the Perform EAD checks operation.

For each mailitem in the request, the response will contain:

The result of the EAD check performed in CDS/GTT.
The rule that IPS would apply for this mailitem (from the IPS EAD check configuration)

Securityips_token

Request

query Parameters

forceeadchecks

string

If true, overrides the national configuration disable all EAD checks as well as the exclude from EAD check of a matching configuration.

Enum: "true" "false"

Request Body schema: application/json

Array of objects (EADMailitem)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden Request

500

Internal Server Error

post/EADCheckService.svc/rest/mailitems

Request samples

Payload

application/json

{"Items": [{"ItemId": "LE22031701XNA",
"OriginCountryCd": "NA",
"DestinationCountryCd": "PL"
}
]
}

Response samples

application/json

[{"DisableAllEADStatusChecks": false,
"EADSound": "MySound.wav",
"Items": [{"ItemId": "LE22031701XNA",
"ReceptacleId": "NAWDHAPLWAWAUN10085001110017",
"ExcludeFromEADCheck": false,
"EADStatus": {"DestinationCountryCd": "NA",
"OriginCountryCd": "PL",
"HasITMATT": false,
"EarliestEventDT": "2022-03-17T17:00:00",
"Referrals": [{"Code": "BCFS",
"EventDT": "2022-03-17T17:00:00",
"ResponsePending": false
}
]
},
"ResponseStatus": [{"Name": "NO_DATA",
"ColorCd": "F0F0F0",
"Message": "No EAD status data for item",
"ShowWarning": true,
"BlockOperation": false
}
]
}
]
}
]

Perform receptacle EAD check

Perform an EAD check on a single receptacle. IPS will call CDS or GTT to perform the checks.

Access to this method is authorized by the Perform EAD checks operation.

For each mailitem found in the specified receptacle, the response will contain:

The result of the EAD check performed in CDS/GTT.
The rule that IPS would apply for this mailitem (from the IPS EAD check configuration)

Securityips_token

Request

query Parameters

receptacleId required	string <= 29 characters ^[A-z0-9]{29}$ Receptacle Identifier. Allowed values: S9 UPU receptacle identifier Example: receptacleId=NLAMSAITLINAAUN10231002000210
forceeadchecks	string If true, overrides the national configuration disable all EAD checks as well as the exclude from EAD check of a matching configuration. Enum: "true" "false"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden Request

500

Internal Server Error

get/EADCheckService.svc/rest/receptacles

Response samples

application/json

[{"DisableAllEADStatusChecks": false,
"EADSound": "MySound.wav",
"Items": [{"ItemId": "LE22031701XNA",
"ReceptacleId": "NAWDHAPLWAWAUN10085001110017",
"ExcludeFromEADCheck": false,
"EADStatus": {"DestinationCountryCd": "NA",
"OriginCountryCd": "PL",
"HasITMATT": false,
"EarliestEventDT": "2022-03-17T17:00:00",
"Referrals": [{"Code": "BCFS",
"EventDT": "2022-03-17T17:00:00",
"ResponsePending": false
}
]
},
"ResponseStatus": [{"Name": "NO_DATA",
"ColorCd": "F0F0F0",
"Message": "No EAD status data for item",
"ShowWarning": true,
"BlockOperation": false
}
]
}
]
}
]

➔ Next to EDI data service