Skip to main content

REST e-Box publication for qualities

REST e-Box publication for qualities​

This section is only for senders in the Social Security domain as they may send messages to recipients with different qualities.

For employers and companies​

The quality codes QUAL_EMP_NOSS, QUAL_EMP_NOSSPLA and QUAL_COMPANY are all enterprise quality codes. In a REST request to send a message to these qualities, you must put enterprise as value for the eboxType property. Example:

messageToPublish:{
     "sender":{
       "eboxType":"enterprise",
       "enterpriseNumber":"0123456789"
     },
     "recipient":{
       "eboxType":"enterprise",
       "enterpriseNumber":"0123456798"
     },
     "subject":{
       "fr":"Example request to publish for an enterprise"
     },
     "messageTypeId":"testMessageType",
     "senderApplicationId":"testApplicationId",
     "attachments":[
       {
         "httpPartName":"upfile1",
         "isMainContent":true,
         "isAttachmentSigned":false
       }
     ],
     "isReplyAuthorized":false
   }

For citizens​

In a REST request to send a message to these qualities, you must put citizen as value for the eboxType property. Example:

messageToPublish:{
     "sender":{
       "eboxType":"enterprise",
       "enterpriseNumber":"0123456789"
     },
     "recipient":{
       "eboxType":"citizen",
       "ssin":"01234567890"
     },
     "subject":{
       "fr":"Example request to publish for a citizen"
     },
     "messageTypeId":"testMessageType",
     "senderApplicationId":"testApplicationId",
     "attachments":[
       {
         "httpPartName":"upfile1",
         "isMainContent":true,
         "isAttachmentSigned":false
       }
     ],
     "isReplyAuthorized":false
   }

Please note that only PDF files work properly for e-Box web application used by citizens.

For Professional personal​

The quality code PROFESSIONAL means a professional quality identified by its SSIN number. To publish to a professional, the value for the eboxType property is citizen and the partition property must have the value QUAL_PROFESSIONAL. In this way, the message is not sent to a professional partition but is sent to the actual professional e-Box. It is not published to an enterprise e-Box. Request example :

messageToPublish:{
     "sender":{
       "eboxType":"enterprise",
       "enterpriseNumber":"0123456798"
     },
     "recipient":{
       "eboxType":"citizen",
       "ssin":"01234567890",
       "partition":"QUAL_PROFESSIONAL"
     },
     "subject":{
       "fr":"Example request to publish for PROFESSIONAL REST request"
     },
     "messageTypeId":"testMessageType",
     "senderApplicationId":"testApplicationId",
     "attachments":[
       {
         "httpPartName":"upfile1",
         "isMainContent":true,
         "isAttachmentSigned":false
       }
     ],
     "isReplyAuthorized":false
   }

If there are several attachments to the message, it is advised to put an attachmentTitle to attachments that are not main content. It will display a correct annex name in the GUI version used by professionals. You still have to not put an attachmentTitle for the main content.

For curator​

The curator quality code is QUAL_CUR. The steps to publish to curators are the same as professional. See the subsection above. The value for the partition property is QUAL_CUR. Example :

messageToPublish:{
     "sender":{
       "eboxType":"enterprise",
       "enterpriseNumber":"0123456798"
     },
     "recipient":{
       "eboxType":"citizen",
       "ssin":"01234567890",
       "partition":"QUAL_CUR"
     },
     "subject":{
       "fr":"Example request to publish for QUAL_CUR REST request"
     },
     "messageTypeId":"testMessageType",
     "senderApplicationId":"testApplicationId",
     "attachments":[
       {
         "httpPartName":"upfile1",
         "isMainContent":true,
         "isAttachmentSigned":false
       }
     ],
     "isReplyAuthorized":false
   }

If there are several attachments to the message, it is advised to put an attachmentTitle to attachments that are not main content. It will display a correct annex name in the GUI version used by curators. You still have to not put an attachmentTitle for the main content.

For institution and mandataries​

For mandataries quality code (QUAL_FSC, QUAL_SP_LEG, QUAL_SSC) and all other qualities like QUAL_SOC_ACTION, QUAL_COMP_PENSION, QUAL_NOTSOC, etc, the value for the eboxType property is enterprise and the partition property must have the same value as the quality code. In this way, the message is sent to the e-Box corresponding to the quality code. For mandatary recipient, a copy is also in the mandatary partition of the enterprise e-Box. Request example :

messageToPublish:{
  "sender":{
    "eboxType":"enterprise",
    "enterpriseNumber":"0123456798"
  },
  "recipient":{
    "eboxType":"enterprise",
    "enterpriseNumber":"0123456789",
    "partition":"QUAL_COMP_PENSION"
  },
  "subject":{
    "fr":"Example publish for QUAL_COMP_PENSION REST request"
  },
  "messageTypeId":"testMessageType",
  "senderApplicationId":"testApplicationId",
  "attachments":[
    {
      "httpPartName":"upfile1",
      "isMainContent":true,
      "isAttachmentSigned":false
    }
  ],
  "isReplyAuthorized":false
}

If there are several attachments to the message, it is advised to put an attachmentTitle to attachments that are not main content. It will display a correct annex name in the GUI version used by mandataries. You still have to not put an attachmentTitle for the main content.