GetRecipientDeliveryActionItems

Overview

The GetRecipientDeliveryActionItems operation retrieves open packages for a recipient.

Table 1. Method
Method URL Description
POST /api/v1/Document/account/{accountId}/WKES/packages The POST method retrieves packges that are in a TODO state for a recipient.
Table 2. Parameters
Name Type Constraints Description
accountId integer required Account associated with the open package for a particular recipient.
RecipientEmailAddress string required Email address associated with the recipient.

Sample Request: 

{
  "emailAddress": "eds.wkes1@gmail.com"
}
Table 3. Responses
Code Description
200 Successful response
Example:
{{
    "packages": [
        {
            "transactionIdentifier": "475096",
            "passthroughIdentifier": "",
            "groupId": "0c633fd5-c445-48cf-9bf4-e558dcd58768",
            "wkesId": "4560085",
            "packageId": "4559659",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "475094",
            "passthroughIdentifier": "",
            "groupId": "f8d86874-85a5-4f70-8f2f-85af90e27d4e",
            "wkesId": "4560074",
            "packageId": "4559648",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "474752",
            "passthroughIdentifier": "667fdb83-e878-4edf-b3a0-e644394dfc9a",
            "groupId": "a64bf8d3-021d-4c20-bcd2-b838d8c77e65",
            "wkesId": "4559375",
            "packageId": "4558944",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "474751",
            "passthroughIdentifier": "42e16955-08c2-44fc-8b47-73d5bbeefe11",
            "groupId": "3beba6c8-a784-445f-81f9-00310313645b",
            "wkesId": "4559370",
            "packageId": "4558939",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "474751",
            "passthroughIdentifier": "42e16955-08c2-44fc-8b47-73d5bbeefe11",
            "groupId": "f17f984e-2b0c-491d-9af1-52bcd6e5ebc9",
            "wkesId": "4559369",
            "packageId": "4558937",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                }
            ]
        },
        {
            "transactionIdentifier": "474716",
            "passthroughIdentifier": "89eafd1d-9997-48e3-bb71-1e4c32323c1f",
            "groupId": "26ebd234-5149-46e1-a026-872ab870bb05",
            "wkesId": "4559303",
            "packageId": "4558870",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "474687",
            "passthroughIdentifier": "4ds45656656",
            "groupId": "74c0ad62-5393-4d65-b3ac-71f2c2f48d3e",
            "wkesId": "4559281",
            "packageId": "4558848",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "474584",
            "passthroughIdentifier": "123465er2345345",
            "groupId": "61225826-9586-457e-ba9f-18e60f9482db",
            "wkesId": "4559272",
            "packageId": "4558839",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "474584",
            "passthroughIdentifier": "123465er2345345",
            "groupId": "f199df43-c3cb-4baa-9498-eb726cb00d62",
            "wkesId": "4559271",
            "packageId": "4558837",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                }
            ]
        },
        {
            "transactionIdentifier": "474540",
            "passthroughIdentifier": "123465er3",
            "groupId": "147db263-0a3b-460f-a2a5-a088d2909641",
            "wkesId": "4559207",
            "packageId": "4558772",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464539",
            "passthroughIdentifier": "",
            "groupId": "4a8863cb-f237-48f4-952a-e339feb3fb44",
            "wkesId": "4558712",
            "packageId": "4558270",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464538",
            "passthroughIdentifier": "",
            "groupId": "8d1a19cb-2e0c-4ad2-9034-cdbfb3e13832",
            "wkesId": "4558659",
            "packageId": "4558217",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464537",
            "passthroughIdentifier": "",
            "groupId": "e00fdc2d-ae31-4f22-aa70-6dec28563775",
            "wkesId": "4558398",
            "packageId": "4557951",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464535",
            "passthroughIdentifier": "",
            "groupId": "1f66710e-1224-4808-a5a8-0f26b92eba6a",
            "wkesId": "4558393",
            "packageId": "4557946",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464535",
            "passthroughIdentifier": "",
            "groupId": "a2ad295c-6f55-4e1c-9436-0caa9d368d71",
            "wkesId": "4558392",
            "packageId": "4557944",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                }
            ]
        },
        {
            "transactionIdentifier": "464533",
            "passthroughIdentifier": "",
            "groupId": "a0490715-5d76-4419-bfb2-b8d951cbb25e",
            "wkesId": "4558390",
            "packageId": "4557942",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464526",
            "passthroughIdentifier": "",
            "groupId": "378d6336-3a30-4348-a71f-1dcf249f60ad",
            "wkesId": "4558213",
            "packageId": "4557765",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464526",
            "passthroughIdentifier": "",
            "groupId": "d9533b56-814e-4f69-9e25-9ba20edd5162",
            "wkesId": "4558212",
            "packageId": "4557763",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                }
            ]
        },
        {
            "transactionIdentifier": "464524",
            "passthroughIdentifier": "",
            "groupId": "c11f9d9c-1ac4-47db-8c3a-bae9cd401645",
            "wkesId": "4558210",
            "packageId": "4557761",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464516",
            "passthroughIdentifier": "",
            "groupId": "41311379-50ce-4582-96d2-867214384e9b",
            "wkesId": "4558142",
            "packageId": "4557690",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        },
        {
            "transactionIdentifier": "464516",
            "passthroughIdentifier": "",
            "groupId": "ef3befb6-cc2c-486c-a244-275b6f388870",
            "wkesId": "4558141",
            "packageId": "4557688",
            "action": "ESIGN",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                }
            ]
        },
        {
            "transactionIdentifier": "464514",
            "passthroughIdentifier": "",
            "groupId": "54303e36-507c-460e-84ba-56612f8bbf7f",
            "wkesId": "4558139",
            "packageId": "4557686",
            "action": "REVIEW",
            "documents": [
                {
                    "docID": "PKGD.NoticeOfHomeownershipCounseling-DEF",
                    "instanceDisplayName": "Notice of Homeownership Counseling - B2_FName B2_MName B2_LName"
                },
                {
                    "docID": "PKGD.HUDForm92070ServicemembersCivilReliefAct-RS",
                    "instanceDisplayName": "HUD Form 92070 Servicemembers Civil Relief Act"
                }
            ]
        }
    ]
}
400 Bad request
401 Not Authorized
403 Forbidden
500 Server error
Example:
{
  "message": "string"
}