Add attachments in an agent portal

In an agent portal, consumers can add attachments to applications and policies.

Adding an attachment to a container, such as an application or policy, is a multistage process:
  1. Upload the file.
  2. Identify the attachment template.
  3. Add an attachment reference from the container to the uploaded file.

Upload the file

Creating an attachment begins with uploading the file to the server using the multifileupload/v3 servlet and then identifying the file name of the document.

For example, the following steps may occur:
  1. The agent portal executes the following API call:
    API 
    POST /multipfileupload/v3
    Request Body filename: filename(s)
    For example:
    Example multifileupload API request
  2. From the API response, note the file name:
    For example:
    {	
	"files": [
		{
			"name": "joystick.png".
			"size": 4321
			"thumbnailUrl": "innovation?rq=File&Filename=/data/upload/joystick-thumb.png"
		}
	]
}

Identify the attachment template

After an agent identifies a policy or application that requires an attachment, the agent portal calls an API to determine the list of applicable attachment templates. Once the agent selects one of the templates, the agent portal notes the template ID of the attachment as it is required to create the attachment.

  1. The portal submits the following API call: 
    GET /attachmentTemplates?container=ContainerType&containerRef=containerSystemID
    • Application example: GET /attachmentTemplates?container=Application&containerRef=6290
    • Policy example: GET /attachmentTemplates?container=Policy&containerRef=484
  2. The portal provides the agent a list of available attachment templates based on the API response and the agent selects one.
  3. From the API response, the portal notes the id of the attachment template that the agent wants to use to create the attachment.
    • Application example:
      {
  "attachmentTemplateListItems": [
    {
      "id": "XApplicationAttachment0015",
      "name": "Signed Application Form",
      "_links": [
        {
          "rel": "self",
          "href": "https://hostname/coreapi/v5/attachmentTemplates/XApplicationAttachment0015?
                container=Application&containerRef=6290"
        }
      ]
    },
    {
      "id": "PApplicationAttachment0003",
      "name": "Inspection",
      "_links": [
        {
          "rel": "self",
          "href": "https://hostname/coreapi/v5/attachmentTemplates/PApplicationAttachment0003?
                container=Application&containerRef=6290"
        }
      ]
    },
   ...
    {
      "id": "ApplicationAttachment3003",
      "name": "Miscellaneous",
      "_links": [
        {
          "rel": "self",
          "href": "https://hostname/coreapi/v5/attachmentTemplates/ApplicationAttachment3003?
                container=Application&containerRef=6290"
        }
      ]
    },
    • Policy example:
      {
  "attachmentTemplateListItems": [
    {
      "id": "HOPAPolicyAttachment0001",
      "name": "Proof of Prior Insurance",
      "_links": [
        {
          "rel": "self",
          "href": "https://hostname/coreapi/v5/attachmentTemplates/HOPAPolicyAttachment0001?
                container=Policy&containerRef=484"
        }
      ]
    },
    ... 
    {
      "id": "PolicyAttachment3003",
      "name": "Miscellaneous",
      "_links": [
        {
          "rel": "self",
          "href": "https://hostname/coreapi/v5/attachmentTemplates/PolicyAttachment3003?
                container=Policy&containerRef=484"
        }
      ]
    },
...

Add an attachment reference

The steps to attach a document differ based on the container or resource type:
Adding an attachment to an application
To add an attachment to an application, execute the following API:
Endpoint 
POST 
​/applications​/systemId​/documents
Example Request Body 
{
  "templateId": "ApplicationAttachment3003",
  "description": "Picture",
  "filename": "joystick.​png",
  "memo": "Accident picture"
}
  • The templateId is the id associated with the attachment template.
  • The filename is the name field from the multipfileupload/v3 API response.
Note: The values will differ based on agent input.
Adding an attachment to a policy
Endpoint 
POST /policies/systemId/documents
Example Request Body 
{
  "templateId": "PolicyAttachment3003",
  "description": "Picture",
  "filename": "joystick.​png",
  "memo": "Accident picture"
}
  • The templateId is the id associated with the attachment template.
  • The filename is the name field from the multipfileupload/v3 API response.
Note: The values will differ based on agent input.
Note: To see an example of adding multiple files in one attachment, see Add attachments in a service portal.