Creating a Subscription for Multiple Business Events
All business events can be included in one subscription or can be created separately.
Full Data and Document Subscription by Organization
This subscription delivers application data at the point of submission, completion, and verification. It also delivers documents present at the time of submission and any documents received after submission.
Your request should be as follows. Remember to replace our [SAMPLE TEXT APPEARING IN BRACKETS] with the appropriate values.
POST /v1/applicationForms/[APPLICATIONFORMID]/organizations/[ORGANIZATIONID]/subscriptions
Authorization: [A VALID AUTHORIZATION TOKEN RETRIEVED FROM POST /v1/auth/token]
Content-Type: application/json
x-api-key: [YOUR CAS API KEY]
Host: [THE APPROPRIATE CAS API ROOT URL: PRODUCTION – api.liaisonedu.com, PRELAUNCH – api.prelaunch.liaisonedu.com]
{
"notificationEmailAddress": "[ENTER A MONITORED EMAIL ADDRESS TO RECEIVE NOTIFICATIONS ABOUT YOUR SUBSCRIPTIONS]",
"subscriptionDetails": [
{
"destinationType": "SFTP",
"event": "application.program.received",
"responseLevel": "program",
"responseType": "fullResponse",
"responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question",
"apiVersion": "v2",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": " [ENTER CAS NAME HERE]_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv"
}
},
{
"destinationType": "SFTP",
"event": "application.program.completed",
"responseLevel": "program",
"responseType": "fullResponse",
"responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question",
"apiVersion": "v2",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": " [ENTER CAS NAME HERE]_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv"
},
{
"destinationType": "SFTP",
"event": "application.program.verified",
"responseLevel": "program",
"responseType": "fullResponse",
"responseOptions": "expand=all,includeNulls=true,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question",
"apiVersion": "v2",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": " [ENTER CAS NAME HERE]_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv"
}
},
{
"destinationType": "SFTP",
"event": "application.program.received",
"responseLevel": "program",
"responseType": "fullResponse",
"responseOptions": "contentType=application/pdf",
"apiVersion": "v1",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": "[ENTER CAS NAME HERE]_app_<casApplicantId>_<programId>_fullAppPDF__<applicationId>!<deliveredDate>.pdf"
}
},
{
"destinationType": "SFTP",
"event": "file.attachment.updated",
"responseLevel": "organization",
"responseType": "fullResponse",
"dataHold": "InProgress",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": "[ENTER CAS NAME HERE]_pers_<casApplicantId>__<documentSubType>__<fileId>!<deliveredDate>.pdf"
}
},
{
"destinationType": "SFTP",
"event": "file.supplementalAttachment.updated",
"responseLevel": "program",
"responseType": "fullResponse",
"dataHold": "InProgress",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": "[ENTER CAS NAME HERE]_app_<casApplicantId>_<programId>_<documentSubType>__<fileId>!<deliveredDate>.pdf"
}
},
{
"destinationType": "SFTP",
"event": "file.evaluation.updated",
"responseLevel": "program",
"responseType": "fullResponse",
"dataHold": "InProgress",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": "[ENTER CAS NAME HERE]_app_<casApplicantId>_<programId>_<docType>__<fileId>!<deliveredDate>.pdf"
}
},
{
"destinationType": "SFTP",
"event": "file.transcript.updated",
"responseLevel": "organization",
"responseType": "fullResponse",
"dataHold": "InProgress",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": "[ENTER CAS NAME HERE]_pers_<casApplicantId>__<docType><transcriptType>_<collegeAttendedId>_<fileId>!<deliveredDate>.pdf"
}
},
{
"destinationType": "SFTP",
"event": "file.vendorTranscriptEval.updated",
"responseLevel": "organization",
"responseType": "fullResponse",
"dataHold": "InProgress",
"sftpDestination": {
"sftpHost": "ft.technolutions.net",
"sftpPort": 22,
"sftpUser": "[ENTER SFTP USERNAME HERE]",
"sftpPassword": "[ENTER SFTP PASSWORD HERE]",
"sftpBaseDirectory": "/incoming/liaison/",
"sftpPathTemplate": "[ENTER CAS NAME HERE]_pers_<casApplicantId>__<docType>_<collegeAttendedId>_<fileId>!<deliveredDate>.pdf"
}
}
]
}