V3 Manage Disasters

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/disasters

Add, update, delete, re-order, or replace disasters collection property entities for the loan, specified by the loan ID, if the user has access rights to the loan.

Usage Notes

See the following notes regarding each action query parameter value:

add - Do not provide “id”. It will be automatically generated.
update - The “id” is required to update the appropriate disaster record. Only properties that are provided in the request are updated.
delete - The “id” of the disaster record that you want to delete is the only property required.
reorder - Reorders the existing collection of disaster records. All disaster record “id’s” must be provided in the payload, in the order you want them, starting with the disaster record you want to appear first, and then so on.
replace - Replaces all disaster records in the collection with disaster records provided in the request payload (i.e., deletes existing collection and then replaces with the disaster records provided in the request). New “id’s” are generated for the replaced disaster records.

Path Params

loanId

string

required

Unique identifier of the loan. Required.

Query Params

action

string

Available values: add, update, delete, reorder, replace

view

string

Optional. View type parameter. Enumerations: entity, id When no view parameter is provided, the API will return 204 - No Content with no response body.

lockId

string

Lock identifier.

includeEmpty

string

Empty fields can be retrieved by passing the query parameter includeEmpty=true.

Body Params

string

System-generated, unique identifier of the disaster collection record ID.

femaDeclarationString

string

Disaster Declaration - FEMA Declaration String

disasterNumber

string

Disaster Declaration - Disaster Number

declarationType

string

Disaster Declaration - Declaration Type
enums: DR, EM, FM

declarationDate

string

Disaster Declaration - Declaration Date
($date-time) Date: yyyy-MM-dd

fiscalYearDeclared

string

Disaster Declaration - Fiscal Year Declared

incidentType

string

Disaster Declaration - Incident Type
enums: Biological, Chemical, Coastal Storm, Dam/Levee Break, Drought, Earthquake, Fire, Fishing Losses, Flood, Freezing, Human Cause, Hurricane, Mud/Landslide, Other, Severe Ice Storm, Severe Storm, Snowstorm, Terrorist, Tornado, Toxic Substances, Tropical Storm, Tsunami, Typhoon, Volcanic Eruption, Winter Storm

declarationTitle

string

Disaster Declaration - Declaration Title

ihProgramDeclared

boolean

Disaster Declaration - Individual Housing Program Declared (IH)

iaProgramDeclared

boolean

Disaster Declaration - Individual Assistance Program Declared (IA)

paProgramDeclared

boolean

Disaster Declaration - Public Assistance Program Declared (PA)Disaster Declaration - Public Assistance Program Declared (PA)

hmProgramDeclared

boolean

Disaster Declaration - Hazard Mitigation Program Declared (HM)

incidentBeginDate

string

Disaster Declaration - Incident Begin Date
($date-time) Date: yyyy-MM-dd

incidentEndDate

string

Disaster Declaration - Incident End Date
($date-time) Date: yyyy-MM-dd

disasterCloseoutDate

string

Disaster Declaration - Disaster Closeout Date
($date-time) Date: yyyy-MM-dd

declarationRequestNumber

string

Disaster Declaration - Declaration Request Number

lastIaFilingDate

string

Disaster Declaration - Last IA Filing Date

lastRefreshDate

string

Disaster Declaration - Last Refresh Date

altId

string

Create Only. ServiceToServiceOnly

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK