|
Binder Status provides an XML based interface to retrieve a list of Binder documents that have
been uploaded, mailed, are required or are in error for the specific lender making the query.
Supported searches include:
- BindersRequired (as sponsor or originator)
- BindersAccepted (as sponsor or originator)
- BindersNotAccepted (as sponsor or originator for paper only, otherwise, as agency that uploaded the electronic binder)
- BinderAdditionRequested (as sponsor or originator)
- BinderAddtionReceived (as sponsor or originator)
To post your data to search the pilot system use https://hwvauwd491.hud.gov/b2b/chums/f17ebstatxml.cfm
To post your data to search the production system use https://entp.hud.gov/b2b/chums/f17ebstatxml.cfm
Sample
Input File
Return to the CHUMS Functions page.
History of Changes
| Addition of Binder Addition searches -- June 2007 |
| Search values BinderAdditionRequested and BinderAddtionReceived are now supported |
| Initial deployment -- January 1, 2006 |
XML File Layout
Key:
| Only used on input |
Element/attribute is not produced by program output unless it is being returned due to an error condition. |
| Only used on output |
Element/attribute is returned by program but is not required or interpreted when the program is called. |
| Used on input and output |
May not always have exactly the same meaning on input an output though. Please consult the reference table from the linked data items for details. |
| Deprecated |
Obsolete; all deprecated elements are supported but please use indicated element. |
| n |
Indicates a numeral, e.g., msg_n may be msg_1, msg_2, msg_3, etc. |
| Data Types |
| Integer |
Indicates a numeral |
| Alphanumeric |
Mixed Text (alphabetic, numeric and punctuation) Note: Some fields restrict some punctuation. |
| Numeric |
Formatted number, e.g. 999.99 |
| String |
Specific keywords as indicated |
| Date |
A valid date, represented as YYYYMMDD |
Linked data names in the XML layout are the FHA Direct/CHUMS data names. Clicking on these links will provide detailed information of the data items. (Links are shown as brown text to avoid obscuring underscores in data names.)
<?xml version='1.0' standalone='yes' ?>
<MULTICASEDATA MISMOVersionID = '1.0'>
<PROCESSSTATUS>
<ProcessStatusCode>stat</ProcessStatusCode>
<ProcessStatusRequestor>browser</ProcessStatusRequestor>
<ProcessStatusMessage sCode = 'n'>Selected n case records.</ProcessStatusMessage>
<ProcessStatusMessage sCode = 'n'>message</ProcessStatusMessage>
<KEY _Name = 'BinderSearchScope' _Value = 'lScope' />
<KEY _Name="BinderSubmissionType" _Value='binderType' />
<KEY _Name = 'InitialBinderSearchDate' _Value = 'sDate' />
<KEY _Name = 'TerminalBinderSearchDate' _Value = 'eDate' />
</PROCESSSTATUS>
<CASEDATA CASEDATAID = 'n'>
<Application>
<AgencyCaseIdentifier>case_num</AgencyCaseIdentifier>
</Application>
<AUDIT_TRAIL>
<AUDIT_ENTRY _Status="UploadedFileName" _Value='fileName'/>
<AUDIT_ENTRY _Status = 'DocumentUploaded' _DateTime = 'time_stamp' />
<AUDIT_ENTRY _Status = 'type' _AuditNumber = 'reason_num' _Message = 'err_mess' />
<AUDIT_ENTRY _Status = 'type' _AuditNumber = 'err_num' _Message = 'err_mess' />
</AUDIT_TRAIL>
</CASEDATA>
</MULTICASEDATA>
Data Description
End of Data Description
| stat |
String |
BindersRequired, BindersAccepted, BindersNotAccepted, BinderAdditionRequested, BinderAdditionReceived on Input, Success, Error on output.
Input values specify type of query, output values specify status of query.
(Required for all searches.)
|
| browser |
String |
Assigned identifying string |
| n |
Numeric |
Number of records found |
| n |
Numeric |
Index to identify message elements, from 1 to total number of messages. |
| message |
Alphanumeric |
Message indicating success or failure of the query. |
| binderType |
String |
Electronic or Paper - Method by which binder was submitted. (Required for all error searches) |
| lScope |
String |
Sponsor or Originator - Restricts search to records where the requestor is either the sponsor or the Originator for the case. (Required for all searches) |
| sDate |
Date |
yyyymmdd - Restricts search to records later than this date. (Not Applicable for "BindersRequired" search, required for all others) |
| eDate |
Date |
yyyymmdd - Restricts search to records previous to this date. (Not Applicable for "BindersRequired" search, required for all others) |
| n |
Numeric |
Index numeral for case record. Sequential for all records returned. |
| case_num |
Numeric |
[Required Input] FHA case number |
| fileName |
Alphanumeric |
Name of uploaded file |
| time_stamp |
Alphanumeric |
Date and time file was uploaded. yyyymmdd hh:mm:ss miliseconds |
| type |
String |
Error or Request. Type of audit entry. |
| reason_num |
Numeric |
Reason number code |
| err_num |
Numeric |
Error number code |
| err_mess |
Alphanumeric |
Message text describing specific problem with binder upload. |
Comments or Questions? <SF Administration>
|