Migration from MessageRegistry V2 to V3
The e-Box MessageRegistry version 2.x will be no longer supported soon. A migration must be done to migrate to the version 3. You must check and download the e-Box MessageRegistry V3 API. While you may prefer to compare both versions with an API viewer like Swagger editor, This page is a summary of changes from V2 to V3 limited to what it was already supported before.
URL
As you can see in the API, the new publication URL does not end with publishMessage but it is a POST on ebox/messages. Thus the URL becomes
| Environment | URL |
|---|---|
| INT (available only in social security network) | https://services-int.socialsecurity.be/REST/ebox/enterprise/messageRegistry/v3/ebox/messages |
| Acceptance | https://services-acpt.socialsecurity.be/REST/ebox/enterprise/messageRegistry/v3/ebox/messages |
| Production | https://services.socialsecurity.be/REST/ebox/enterprise/messageRegistry/v3/ebox/messages |
Renamed properties
| Property | Change in V3 |
|---|---|
| sender | In V3, there is no more senderOrganizationId property. Only the sender object is available to encode the sender. The eboxIdValue becomes enterpriseNumber. The enterprise number still needs to be encoded on 10 digits. |
| recipient | The eboxIdValue in the recipient object is replaced by enterpriseNumber or ssin. If the eboxType is enterprise, then the eboxIdValue is replaced by enterpriseNumber. If the eboxType is citizen, then the eboxIdValue is replaced by ssin. |
| attachment | As most boolean properties, a "is" prefix is added to follow the Gcloud guidelines. Thus mainContent becomes isMainContent and attachmentSigned becomes isAttachmentSigned. |
| forTheAttentionOf | If you put a forTheAttentionOf object in your request, you must check the new object definition. There is no more type property. The id becomes ssin and name becomes label. Please check that the identifier is a valid SSIN before putting a forTheAttentionOf in the request else the request will fail. |
| Boolean properties | A "is" prefix is added to follow the Gcloud guidelines so bodyMainContent becomes isBodyMainContent, replyAuthorized becomes isReplyAuthorized, registeredMail becomes isRegisteredMail. Note that we recommend to not put the isRegisteredMail as the default value already handle it and you cannot send registered mail without following further juridical criteria. |
New feature you may be interested
Idempotency
The idempotency is a HTTP header that you can add to avoid duplicate publication. It is recommended if you implemented a retry mechanism.