Form Simplicity API Documentation
Endpoint: /fsforms
Used for fetching Transaction details.
FS List Transactions
Required scope: transactions.read
Endpoint path: /fsforms/listTrans
Endpoint details: Used for fetching the list of avaiable transaction that are associated with a Forms Simplicity user-level account.
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/listTrans
Request Body
{
"userId" : {vendorEmailId}
"batch_size" : {batch_size},
"batch_no" : {batch_no},
"sort" : {sort},
"filter" : {filter}
"full_details": {full_details}
}
{batch_size} : [optional] size of batch returned (default=20, max=100)
{batch_no} : [optional] batch/page number (default=1)
{sort} : [optional] string which contains the sort category and optionally the sort direction (default ascending);
format: category [:asc|desc],
e.g. address or address:asc produce the same results.
Possible sort categories: transName, realtorName, insertDate, lastUpdateDate, propertyType,
transactionType, propertyStatus, listingPrice, listingStartDate,
listingExpDate, purchasePrice, purchaseAgreementDate, earnestMoneyDueDate, closingDate
{filter} : format: filter_key=<filtervalue>
e.g. NRDSID=<9999999>, propertyStatus=<A|P>
[required] filter keys: NRDSID=<NRDSID>
[optional] filter keys: realtorName=<realtorName>, lastUpdateDate=<timestamp>,
insertDate=<timestamp>, propertyType=<type>[|<type>|…],
transactionType=<type>[|<type>|…], propertyStatus=<
status>[|<status>|…], listingStartDate=<timestamp>,
listingExpDate=<timestamp>, purchaseAgreementDate=<timestamp>,
earnestMoneyDueDate=<timestamp>, closingDate=<timestamp>,
insertDate_min=<timestamp>,lastUpdateDate_since=<timestamp>,
closingDate_range=<timestamp - timestamp>
{full_details} : [optional] flag to include all available details with each record returned; [true|false] (default: false)
Property Type:
Code Description
C Commercial
R Residential
V Vacant Land
F Farm and Ranch
Transaction Type:
Code Description
A Listing
P Purchase
G Listing & Purchase
Property Status:
Code Description
X Closed
E Expired
P Pending
W Withdrawn
A Active
N New
L Leased/Rented
T Terminated
R Rejected
Response: SUCCESS
Response Body
if {full_details} == true
[
{
"meta": {
"total": {total records fetched in this batch},
"max": {total records that match the filter criteria},
"next_batch_no": {next batch number}
},
"data": [{
"transName": {transName},
"realtorName": {realtorName},
"insertDate": {insertDate},
"lastUpdateDate": {lastUpdateDate}
"propertyType": {propertyType},
"transactionType": {transactionType},
"propertyStatus": {propertyStatus},
"streetAddress": {streetAddress},
"unitNo": {unitNo},
"City": {City},
"State": {State},
"Zip": {Zip},
"countyParcel": {countyParcel},
"legalDescription": {legalDescription},
"Subdivision": {Subdivision},
"countyName": {countyName},
"yearBuilt": {yearBuilt},
"Bedrooms": {Bedrooms},
"Baths": {Baths},
"MLSListingID": {MLSListingID},
"listingPrice": {listingPrice},
"listingStartDate": {listingStartDate},
"listingExpDate": {listingExpDate},
"associationFees": {associationFees},
"purchasePrice": {purchasePrice},
"purchaseAgreementDate": {purchaseAgreementDate},
"earnestMoneyDueDate": {earnestMoneyDueDate},
"dueDiligenceDate": {dueDiligenceDate},
"earnestMoney": {earnestMoney},
"projectedClosingDate": {projectedClosingDate},
"sellerLandlordName": {sellerLandlordName},
"sellerParty1Name" :{sellerParty1Name},
"sellerParty1Address" :{sellerParty1Address},
"sellerParty1ID" : {sellerParty1ID},
"sellerParty1Email" : {sellerParty1Email},
"sellerParty1HomePhone" :{sellerParty1HomePhone},
"sellerParty1WorkPhone" : {sellerParty1WorkPhone},
"sellerParty1CellPhone" : {sellerParty1CellPhone},
"sellerParty1Fax" : {sellerParty1Fax},
"sellerParty2Name" :{sellerParty2Name},
"sellerParty2Address" :{sellerParty2Address},
"sellerParty2ID" : {sellerParty2ID},
"sellerParty2Email" : {sellerParty2Email},
"sellerParty2HomePhone" :{sellerParty2HomePhone},
"sellerParty2WorkPhone" : {sellerParty2WorkPhone},
"sellerParty2CellPhone" : {sellerParty2CellPhone},
"sellerParty2Fax" : {sellerParty2Fax},
"sellerParty3Name" :{sellerParty3Name},
"sellerParty3Address" :{sellerParty3Address},
"sellerParty3ID" : {sellerParty3ID},
"sellerParty3Email" : {sellerParty3Email},
"sellerParty3HomePhone" :{sellerParty3HomePhone},
"sellerParty3WorkPhone" : {sellerParty3WorkPhone},
"sellerParty3CellPhone" : {sellerParty3CellPhone},
"sellerParty3Fax" : {sellerParty3Fax},
"sellerParty4Name" :{sellerParty4Name},
"sellerParty4Address" :{sellerParty4Address},
"sellerParty4ID" : {sellerParty4ID},
"sellerParty4Email" : {sellerParty4Email},
"sellerParty4HomePhone" :{sellerParty4HomePhone},
"sellerParty4WorkPhone" : {sellerParty4WorkPhone},
"sellerParty4CellPhone" : {sellerParty4CellPhone},
"sellerParty4Fax" : {sellerParty4Fax},
"sellerParty5Name" :{sellerParty5Name},
"sellerParty5Address" :{sellerParty5Address},
"sellerParty5ID" : {sellerParty5ID},
"sellerParty5Email" : {sellerParty5Email},
"sellerParty5HomePhone" :{sellerParty5HomePhone},
"sellerParty5WorkPhone" : {sellerParty5WorkPhone},
"sellerParty5CellPhone" : {sellerParty5CellPhone},
"sellerParty5Fax" : {sellerParty5Fax},
"sellerParty6Name" :{sellerParty6Name},
"sellerParty6Address" :{sellerParty6Address},
"sellerParty6ID" : {sellerParty6ID},
"sellerParty6Email" : {sellerParty6Email},
"sellerParty6HomePhone" :{sellerParty6HomePhone},
"sellerParty6WorkPhone" : {sellerParty6WorkPhone},
"sellerParty6CellPhone" : {sellerParty6CellPhone},
"sellerParty6Fax" : {sellerParty6Fax},
"sellerParty7Name" :{sellerParty7Name},
"sellerParty7Address" :{sellerParty7Address},
"sellerParty7ID" : {sellerParty7ID},
"sellerParty7Email" : {sellerParty7Email},
"sellerParty7HomePhone" :{sellerParty7HomePhone},
"sellerParty7WorkPhone" : {sellerParty7WorkPhone},
"sellerParty7CellPhone" : {sellerParty7CellPhone},
"sellerParty7Fax" : {sellerParty7Fax},
"sellerParty8Name" :{sellerParty8Name},
"sellerParty8Address" :{sellerParty8Address},
"sellerParty8ID" : {sellerParty8ID},
"sellerParty8Email" : {sellerParty8Email},
"sellerParty8HomePhone" :{sellerParty8HomePhone},
"sellerParty8WorkPhone" : {sellerParty8WorkPhone},
"sellerParty8CellPhone" : {sellerParty8CellPhone},
"sellerParty8Fax" : {sellerParty8Fax},
"sellerBrokerageName": {sellerBrokerageName},
"sellerBrokerageAddress": {sellerBrokerageAddress},
"sellerBrokeragePhone":{sellerBrokeragePhone},
"sellerBrokerageFax": {sellerBrokerageFax},
"sellerBrokerageID": {sellerBrokerageID},
"sellerBrokerName": {sellerBrokerName},
"sellerBrokerID": {sellerBrokerID},
"sellerBrokerEmail": {sellerBrokerEmail},
"sellerAgentName": {sellerAgentName},
"sellerAgentID": {sellerAgentID},
"sellerAgentEmail": {sellerAgentEmail},
"sellerAgentWorkPhone": {sellerAgentWorkPhone},
"sellerAgentHomePhone": {sellerAgentHomePhone},
"sellerAgentCellPhone": {sellerAgentCellPhone},
"sellerAgentFaxNo": {sellerAgentFaxNo},
"sellerAgentNRDSID": {sellerAgentNRDSID},
"buyerLandlordName": {buyerLandlordName},
"buyerParty1Name" :{buyerParty1Name},
"buyerParty1Address" :{buyerParty1Address},
"buyerParty1ID" : {buyerParty1ID},
"buyerParty1Email" : {buyerParty1Email},
"buyerParty1HomePhone" :{buyerParty1HomePhone},
"buyerParty1WorkPhone" : {buyerParty1WorkPhone},
"buyerParty1CellPhone" : {buyerParty1CellPhone},
"buyerParty1Fax" : {buyerParty1Fax},
"buyerParty2Name" :{buyerParty2Name},
"buyerParty2Address" :{buyerParty2Address},
"buyerParty2ID" : {buyerParty2ID},
"buyerParty2Email" : {buyerParty2Email},
"buyerParty2HomePhone" :{buyerParty2HomePhone},
"buyerParty2WorkPhone" : {buyerParty2WorkPhone},
"buyerParty2CellPhone" : {buyerParty2CellPhone},
"buyerParty2Fax" : {buyerParty2Fax},
"buyerParty3Name" :{buyerParty3Name},
"buyerParty3Address" :{buyerParty3Address},
"buyerParty3ID" : {buyerParty3ID},
"buyerParty3Email" : {buyerParty3Email},
"buyerParty3HomePhone" :{buyerParty3HomePhone},
"buyerParty3WorkPhone" : {buyerParty3WorkPhone},
"buyerParty3CellPhone" : {buyerParty3CellPhone},
"buyerParty3Fax" : {buyerParty3Fax},
"buyerParty4Name" :{buyerParty4Name},
"buyerParty4Address" :{buyerParty4Address},
"buyerParty4ID" : {buyerParty4ID},
"buyerParty4Email" : {buyerParty4Email},
"buyerParty4HomePhone" :{buyerParty4HomePhone},
"buyerParty4WorkPhone" : {buyerParty4WorkPhone},
"buyerParty4CellPhone" : {buyerParty4CellPhone},
"buyerParty4Fax" : {buyerParty4Fax},
"buyerParty5Name" :{buyerParty5Name},
"buyerParty5Address" :{buyerParty5Address},
"buyerParty5ID" : {buyerParty5ID},
"buyerParty5Email" : {buyerParty5Email},
"buyerParty5HomePhone" :{buyerParty5HomePhone},
"buyerParty5WorkPhone" : {buyerParty5WorkPhone},
"buyerParty5CellPhone" : {buyerParty5CellPhone},
"buyerParty5Fax" : {buyerParty5Fax},
"buyerParty6Name" :{buyerParty6Name},
"buyerParty6Address" :{buyerParty6Address},
"buyerParty6ID" : {buyerParty6ID},
"buyerParty6Email" : {buyerParty6Email},
"buyerParty6HomePhone" :{buyerParty6HomePhone},
"buyerParty6WorkPhone" : {buyerParty6WorkPhone},
"buyerParty6CellPhone" : {buyerParty6CellPhone},
"buyerParty6Fax" : {buyerParty6Fax},
"buyerParty7Name" :{buyerParty7Name},
"buyerParty7Address" :{buyerParty7Address},
"buyerParty7ID" : {buyerParty7ID},
"buyerParty7Email" : {buyerParty7Email},
"buyerParty7HomePhone" :{buyerParty7HomePhone},
"buyerParty7WorkPhone" : {buyerParty7WorkPhone},
"buyerParty7CellPhone" : {buyerParty7CellPhone},
"buyerParty7Fax" : {buyerParty7Fax},
"buyerParty8Name" :{buyerParty8Name},
"buyerParty8Address" :{buyerParty8Address},
"buyerParty8ID" : {buyerParty8ID},
"buyerParty8Email" : {buyerParty8Email},
"buyerParty8HomePhone" :{buyerParty8HomePhone},
"buyerParty8WorkPhone" : {buyerParty8WorkPhone},
"buyerParty8CellPhone" : {buyerParty8CellPhone},
"buyerParty8Fax" : {buyerParty8Fax},
"buyerBrokerageName": {buyerBrokerageName},
"buyerBrokerageAddress": {buyerBrokerageAddress},
"buyerBrokeragePhone":{buyerBrokeragePhone},
"buyerBrokerageFax": {buyerBrokerageFax},
"buyerBrokerageID": {buyerBrokerageID},
"buyerBrokerName": {buyerBrokerName},
"buyerBrokerID": {buyerBrokerID},
"buyerBrokerEmail": {buyerBrokerEmail},
"buyerAgentName": {buyerAgentName},
"buyerAgentID": {buyerAgentID},
"buyerAgentEmail": {buyerAgentEmail},
"buyerAgentWorkPhone": {buyerAgentWorkPhone},
"buyerAgentHomePhone": {buyerAgentHomePhone},
"buyerAgentCellPhone": {buyerAgentCellPhone},
"buyerAgentFaxNo": {buyerAgentFaxNo},
"buyerAgentNRDSID": {buyerAgentNRDSID},
"escrowCompanyRepresents": {escrowCompanyRepresents},
"escrowAgent": {escrowAgent},
"escrowCompanyName": {escrowCompanyName},
"escrowCompanyAddress": {escrowCompanyAddress},
"escrowEmailAddress":{escrowEmailAddress},
"escrowPhone": {escrowPhone},
"escrowFax": {escrowFax},
"titleCompanyRepresents": {titleCompanyRepresents},
"titleAgent": {titleAgent},
"titleCompanyName": {titleCompanyName},
"titleCompanyAddress": {titleCompanyAddress},
"titleEmailAddress": {titleEmailAddress},
"titlePhone": {titlePhone},
"titleFax": {titleFax},
"title2CompanyRepresents": {title2CompanyRepresents},
"title2Agent":{title2Agent},
"title2CompanyName": {title2CompanyName},
"title2CompanyAddress": {title2CompanyAddress},
"title2EmailAddress": {title2EmailAddress},
"title2Phone": {title2Phone},
"title2Fax": {title2Fax},
"lendingCompanyRepresents": {lendingCompanyRepresents},
"lendingAgent": {lendingAgent},
"lendingCompanyName": {lendingCompanyName},
"lendingCompanyAddress": {lendingCompanyAddress},
"lendingEmailAddress": {lendingEmailAddress},
"lendingPhone": {lendingPhone},
"lendingFax": {lendingFax},
"closingCompanyRepresents": {closingCompanyRepresents},
"closingAgent": {closingAgent},
"closingCompanyName":{closingCompanyName},
"closingCompanyAddress": {closingCompanyAddress},
"closingEmailAddress": {closingEmailAddress},
"closingPhone": {closingPhone},
"closingFax": {closingFax},
"propertyAppraisalCompanyRepresents": {propertyAppraisalCompanyRepresents},
"propertyAppraisalCompanyName": {propertyAppraisalCompanyName},
"propertyAppraisalCompanyAddress": {propertyAppraisalCompanyAddress},
"propertyAppraisalEmailAddress": {propertyAppraisalEmailAddress},
"propertyAppraisalPhone": {propertyAppraisalPhone},
"propertyAppraisalFax": {propertyAppraisalFax},
"inspectionCompanyRepresents": {inspectionCompanyRepresents},
"inspectionAgent": {inspectionAgent},
"inspectionCompanyName": {inspectionCompanyName},
"inspectionCompanyAddress": {inspectionCompanyAddress},
"inspectionEmailAddress": {inspectionEmailAddress},
"inspectionPhone": {inspectionPhone},
"inspectionFax": {inspectionFax},
"transId" " {transId}
}
]
}
]
if {full_details} == false
[
{
"meta": {
"total": {total records fetched in this batch},
"max": {total records that match the filter criteria},
"next_batch_no": {next batch number}
},
"data": [
{
"transName": {transName},
"realtorName": {realtorName},
"insertDate": {insertDate},
"lastUpdateDate": {lastUpdateDate}
"propertyType": {propertyType},
"transactionType": {transactionType},
"propertyStatus": {propertyStatus}
}
]
}
]
Response: ERROR
| Error Code | Error Type |
|---|---|
| 400 Bad Request | Missing Required Parameter |
| 401 Unauthorized | Access Denied |
| 403 New Transaction Failure | Transaction creation failed: { Error message} |
| 404 List Transactions Request Failure | Invalid Filter: {Filter Error} |
See
Exception Documentation
for more details
FS Transaction
Required scope: transactions.read
Endpoint path: /fsforms/getTransById
Endpoint details: Used for fetching an individual transaction that is associated with a Forms Simplicity user-level account.
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/getTransById
Request Body
{
"userId" : {vendorEmailId}
"transId": {transId}
}
Response: SUCCESS
Response Body
[
{
"transName": {transName},
"realtorName": {realtorName},
"insertDate": {insertDate},
"lastUpdateDate": {lastUpdateDate}
"propertyType": {propertyType},
"transactionType": {transactionType},
"propertyStatus": {propertyStatus},
"streetAddress": {streetAddress},
"unitNo": {unitNo},
"City": {City},
"State": {State},
"Zip": {Zip},
"countyParcel": {countyParcel},
"legalDescription": {legalDescription},
"Subdivision": {Subdivision},
"countyName": {countyName},
"yearBuilt": {yearBuilt},
"Bedrooms": {Bedrooms},
"Baths": {Baths},
"MLSListingID": {MLSListingID},
"listingPrice": {listingPrice},
"listingStartDate": {listingStartDate},
"listingExpDate": {listingExpDate},
"associationFees": {associationFees},
"purchasePrice": {purchasePrice},
"purchaseAgreementDate": {purchaseAgreementDate},
"earnestMoneyDueDate": {earnestMoneyDueDate},
"dueDiligenceDate": {dueDiligenceDate},
"earnestMoney": {earnestMoney},
"projectedClosingDate": {projectedClosingDate},
"sellerLandlordName": {sellerLandlordName},
"sellerParty1Name" :{sellerParty1Name},
"sellerParty1Address" :{sellerParty1Address},
"sellerParty1ID" : {sellerParty1ID},
"sellerParty1Email" : {sellerParty1Email},
"sellerParty1HomePhone" :{sellerParty1HomePhone},
"sellerParty1WorkPhone" : {sellerParty1WorkPhone},
"sellerParty1CellPhone" : {sellerParty1CellPhone},
"sellerParty1Fax" : {sellerParty1Fax},
"sellerParty2Name" :{sellerParty2Name},
"sellerParty2Address" :{sellerParty2Address},
"sellerParty2ID" : {sellerParty2ID},
"sellerParty2Email" : {sellerParty2Email},
"sellerParty2HomePhone" :{sellerParty2HomePhone},
"sellerParty2WorkPhone" : {sellerParty2WorkPhone},
"sellerParty2CellPhone" : {sellerParty2CellPhone},
"sellerParty2Fax" : {sellerParty2Fax},
"sellerParty3Name" :{sellerParty3Name},
"sellerParty3Address" :{sellerParty3Address},
"sellerParty3ID" : {sellerParty3ID},
"sellerParty3Email" : {sellerParty3Email},
"sellerParty3HomePhone" :{sellerParty3HomePhone},
"sellerParty3WorkPhone" : {sellerParty3WorkPhone},
"sellerParty3CellPhone" : {sellerParty3CellPhone},
"sellerParty3Fax" : {sellerParty3Fax},
"sellerParty4Name" :{sellerParty4Name},
"sellerParty4Address" :{sellerParty4Address},
"sellerParty4ID" : {sellerParty4ID},
"sellerParty4Email" : {sellerParty4Email},
"sellerParty4HomePhone" :{sellerParty4HomePhone},
"sellerParty4WorkPhone" : {sellerParty4WorkPhone},
"sellerParty4CellPhone" : {sellerParty4CellPhone},
"sellerParty4Fax" : {sellerParty4Fax},
"sellerParty5Name" :{sellerParty5Name},
"sellerParty5Address" :{sellerParty5Address},
"sellerParty5ID" : {sellerParty5ID},
"sellerParty5Email" : {sellerParty5Email},
"sellerParty5HomePhone" :{sellerParty5HomePhone},
"sellerParty5WorkPhone" : {sellerParty5WorkPhone},
"sellerParty5CellPhone" : {sellerParty5CellPhone},
"sellerParty5Fax" : {sellerParty5Fax},
"sellerParty6Name" :{sellerParty6Name},
"sellerParty6Address" :{sellerParty6Address},
"sellerParty6ID" : {sellerParty6ID},
"sellerParty6Email" : {sellerParty6Email},
"sellerParty6HomePhone" :{sellerParty6HomePhone},
"sellerParty6WorkPhone" : {sellerParty6WorkPhone},
"sellerParty6CellPhone" : {sellerParty6CellPhone},
"sellerParty6Fax" : {sellerParty6Fax},
"sellerParty7Name" :{sellerParty7Name},
"sellerParty7Address" :{sellerParty7Address},
"sellerParty7ID" : {sellerParty7ID},
"sellerParty7Email" : {sellerParty7Email},
"sellerParty7HomePhone" :{sellerParty7HomePhone},
"sellerParty7WorkPhone" : {sellerParty7WorkPhone},
"sellerParty7CellPhone" : {sellerParty7CellPhone},
"sellerParty7Fax" : {sellerParty7Fax},
"sellerParty8Name" :{sellerParty8Name},
"sellerParty8Address" :{sellerParty8Address},
"sellerParty8ID" : {sellerParty8ID},
"sellerParty8Email" : {sellerParty8Email},
"sellerParty8HomePhone" :{sellerParty8HomePhone},
"sellerParty8WorkPhone" : {sellerParty8WorkPhone},
"sellerParty8CellPhone" : {sellerParty8CellPhone},
"sellerParty8Fax" : {sellerParty8Fax},
"sellerBrokerageName": {sellerBrokerageName},
"sellerBrokerageAddress": {sellerBrokerageAddress},
"sellerBrokeragePhone":{sellerBrokeragePhone},
"sellerBrokerageFax": {sellerBrokerageFax},
"sellerBrokerageID": {sellerBrokerageID},
"sellerBrokerName": {sellerBrokerName},
"sellerBrokerID": {sellerBrokerID},
"sellerBrokerEmail": {sellerBrokerEmail},
"sellerAgentName": {sellerAgentName},
"sellerAgentID": {sellerAgentID},
"sellerAgentEmail": {sellerAgentEmail},
"sellerAgentWorkPhone": {sellerAgentWorkPhone},
"sellerAgentHomePhone": {sellerAgentHomePhone},
"sellerAgentCellPhone": {sellerAgentCellPhone},
"sellerAgentFaxNo": {sellerAgentFaxNo},
"sellerAgentNRDSID": {sellerAgentNRDSID},
"buyerLandlordName": {buyerLandlordName},
"buyerParty1Name" :{buyerParty1Name},
"buyerParty1Address" :{buyerParty1Address},
"buyerParty1ID" : {buyerParty1ID},
"buyerParty1Email" : {buyerParty1Email},
"buyerParty1HomePhone" :{buyerParty1HomePhone},
"buyerParty1WorkPhone" : {buyerParty1WorkPhone},
"buyerParty1CellPhone" : {buyerParty1CellPhone},
"buyerParty1Fax" : {buyerParty1Fax},
"buyerParty2Name" :{buyerParty2Name},
"buyerParty2Address" :{buyerParty2Address},
"buyerParty2ID" : {buyerParty2ID},
"buyerParty2Email" : {buyerParty2Email},
"buyerParty2HomePhone" :{buyerParty2HomePhone},
"buyerParty2WorkPhone" : {buyerParty2WorkPhone},
"buyerParty2CellPhone" : {buyerParty2CellPhone},
"buyerParty2Fax" : {buyerParty2Fax},
"buyerParty3Name" :{buyerParty3Name},
"buyerParty3Address" :{buyerParty3Address},
"buyerParty3ID" : {buyerParty3ID},
"buyerParty3Email" : {buyerParty3Email},
"buyerParty3HomePhone" :{buyerParty3HomePhone},
"buyerParty3WorkPhone" : {buyerParty3WorkPhone},
"buyerParty3CellPhone" : {buyerParty3CellPhone},
"buyerParty3Fax" : {buyerParty3Fax},
"buyerParty4Name" :{buyerParty4Name},
"buyerParty4Address" :{buyerParty4Address},
"buyerParty4ID" : {buyerParty4ID},
"buyerParty4Email" : {buyerParty4Email},
"buyerParty4HomePhone" :{buyerParty4HomePhone},
"buyerParty4WorkPhone" : {buyerParty4WorkPhone},
"buyerParty4CellPhone" : {buyerParty4CellPhone},
"buyerParty4Fax" : {buyerParty4Fax},
"buyerParty5Name" :{buyerParty5Name},
"buyerParty5Address" :{buyerParty5Address},
"buyerParty5ID" : {buyerParty5ID},
"buyerParty5Email" : {buyerParty5Email},
"buyerParty5HomePhone" :{buyerParty5HomePhone},
"buyerParty5WorkPhone" : {buyerParty5WorkPhone},
"buyerParty5CellPhone" : {buyerParty5CellPhone},
"buyerParty5Fax" : {buyerParty5Fax},
"buyerParty6Name" :{buyerParty6Name},
"buyerParty6Address" :{buyerParty6Address},
"buyerParty6ID" : {buyerParty6ID},
"buyerParty6Email" : {buyerParty6Email},
"buyerParty6HomePhone" :{buyerParty6HomePhone},
"buyerParty6WorkPhone" : {buyerParty6WorkPhone},
"buyerParty6CellPhone" : {buyerParty6CellPhone},
"buyerParty6Fax" : {buyerParty6Fax},
"buyerParty7Name" :{buyerParty7Name},
"buyerParty7Address" :{buyerParty7Address},
"buyerParty7ID" : {buyerParty7ID},
"buyerParty7Email" : {buyerParty7Email},
"buyerParty7HomePhone" :{buyerParty7HomePhone},
"buyerParty7WorkPhone" : {buyerParty7WorkPhone},
"buyerParty7CellPhone" : {buyerParty7CellPhone},
"buyerParty7Fax" : {buyerParty7Fax},
"buyerParty8Name" :{buyerParty8Name},
"buyerParty8Address" :{buyerParty8Address},
"buyerParty8ID" : {buyerParty8ID},
"buyerParty8Email" : {buyerParty8Email},
"buyerParty8HomePhone" :{buyerParty8HomePhone},
"buyerParty8WorkPhone" : {buyerParty8WorkPhone},
"buyerParty8CellPhone" : {buyerParty8CellPhone},
"buyerParty8Fax" : {buyerParty8Fax},
"buyerBrokerageName": {buyerBrokerageName},
"buyerBrokerageAddress": {buyerBrokerageAddress},
"buyerBrokeragePhone":{buyerBrokeragePhone},
"buyerBrokerageFax": {buyerBrokerageFax},
"buyerBrokerageID": {buyerBrokerageID},
"buyerBrokerName": {buyerBrokerName},
"buyerBrokerID": {buyerBrokerID},
"buyerBrokerEmail": {buyerBrokerEmail},
"buyerAgentName": {buyerAgentName},
"buyerAgentID": {buyerAgentID},
"buyerAgentEmail": {buyerAgentEmail},
"buyerAgentWorkPhone": {buyerAgentWorkPhone},
"buyerAgentHomePhone": {buyerAgentHomePhone},
"buyerAgentCellPhone": {buyerAgentCellPhone},
"buyerAgentFaxNo": {buyerAgentFaxNo},
"buyerAgentNRDSID": {buyerAgentNRDSID},
"escrowCompanyRepresents": {escrowCompanyRepresents},
"escrowAgent": {escrowAgent},
"escrowCompanyName": {escrowCompanyName},
"escrowCompanyAddress": {escrowCompanyAddress},
"escrowEmailAddress":{escrowEmailAddress},
"escrowPhone": {escrowPhone},
"escrowFax": {escrowFax},
"titleCompanyRepresents": {titleCompanyRepresents},
"titleAgent": {titleAgent},
"titleCompanyName": {titleCompanyName},
"titleCompanyAddress": {titleCompanyAddress},
"titleEmailAddress": {titleEmailAddress},
"titlePhone": {titlePhone},
"titleFax": {titleFax},
"title2CompanyRepresents": {title2CompanyRepresents},
"title2Agent":{title2Agent},
"title2CompanyName": {title2CompanyName},
"title2CompanyAddress": {title2CompanyAddress},
"title2EmailAddress": {title2EmailAddress},
"title2Phone": {title2Phone},
"title2Fax": {title2Fax},
"lendingCompanyRepresents": {lendingCompanyRepresents},
"lendingAgent": {lendingAgent},
"lendingCompanyName": {lendingCompanyName},
"lendingCompanyAddress": {lendingCompanyAddress},
"lendingEmailAddress": {lendingEmailAddress},
"lendingPhone": {lendingPhone},
"lendingFax": {lendingFax},
"closingCompanyRepresents": {closingCompanyRepresents},
"closingAgent": {closingAgent},
"closingCompanyName":{closingCompanyName},
"closingCompanyAddress": {closingCompanyAddress},
"closingEmailAddress": {closingEmailAddress},
"closingPhone": {closingPhone},
"closingFax": {closingFax},
"propertyAppraisalCompanyRepresents": {propertyAppraisalCompanyRepresents},
"propertyAppraisalCompanyName": {propertyAppraisalCompanyName},
"propertyAppraisalCompanyAddress": {propertyAppraisalCompanyAddress},
"propertyAppraisalEmailAddress": {propertyAppraisalEmailAddress},
"propertyAppraisalPhone": {propertyAppraisalPhone},
"propertyAppraisalFax": {propertyAppraisalFax},
"inspectionCompanyRepresents": {inspectionCompanyRepresents},
"inspectionAgent": {inspectionAgent},
"inspectionCompanyName": {inspectionCompanyName},
"inspectionCompanyAddress": {inspectionCompanyAddress},
"inspectionEmailAddress": {inspectionEmailAddress},
"inspectionPhone": {inspectionPhone},
"inspectionFax": {inspectionFax}
} ]
Response: ERROR
| Error Code | Error Type |
|---|---|
| 401 Unauthorized | Access Denied |
| 400 Bad Request | Missing Required Parameter |
See
Exception Documentation
for more details
FS Add Transaction
Required scope: transactions.create
Endpoint path: /fsforms/addTrans
Endpoint details: Used for creating a new transaction within a Forms Simplicity user-level account.
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/addTrans
Request Body
{
"userId" : {vendorEmailId}
"stateID" : {stateID},
"agentNRDSID" : {agentNRDSID},
"transName" : {transName},
"streetAddress" : {streetAddress},
"propertyType" : {propertyTypeCode},
"transactionType": {transactionTypeCode},
"propertyStatus" : {propertyStatusCode}
}
Property Type:
Code Description
C Commercial
R Residential
V Vacant Land
F Farm and Ranch
Transaction Type:
Code Description
A Listing
P Purchase
L Lease/Rental
G Listing & Purchase
Property Status:
Code Description
X Closed
E Expired
P Pending
W Withdrawn
A Active
N New
L Leased/Rented
T Terminated
R Rejected
Response: SUCCESS
Response Body
[
{
"transName": {transName},
"realtorName": {realtorName},
"insertDate": {insertDate},
"lastUpdateDate": {lastUpdateDate}
"propertyType": {propertyType},
"transactionType": {transactionType},
"propertyStatus": {propertyStatus},
"streetAddress": {streetAddress},
"unitNo": {unitNo},
"City": {City},
"State": {State},
"Zip": {Zip},
"countyParcel": {countyParcel},
"legalDescription": {legalDescription},
"Subdivision": {Subdivision},
"countyName": {countyName},
"yearBuilt": {yearBuilt},
"Bedrooms": {Bedrooms},
"Baths": {Baths},
"MLSListingID": {MLSListingID},
"listingPrice": {listingPrice},
"listingStartDate": {listingStartDate},
"listingExpDate": {listingExpDate},
"associationFees": {associationFees},
"purchasePrice": {purchasePrice},
"purchaseAgreementDate": {purchaseAgreementDate},
"earnestMoneyDueDate": {earnestMoneyDueDate},
"dueDiligenceDate": {dueDiligenceDate},
"earnestMoney": {earnestMoney},
"projectedClosingDate": {projectedClosingDate},
"sellerLandlordName": {sellerLandlordName},
"sellerParty1Name" :{sellerParty1Name},
"sellerParty1Address" :{sellerParty1Address},
"sellerParty1ID" : {sellerParty1ID},
"sellerParty1Email" : {sellerParty1Email},
"sellerParty1HomePhone" :{sellerParty1HomePhone},
"sellerParty1WorkPhone" : {sellerParty1WorkPhone},
"sellerParty1CellPhone" : {sellerParty1CellPhone},
"sellerParty1Fax" : {sellerParty1Fax},
"sellerParty2Name" :{sellerParty2Name},
"sellerParty2Address" :{sellerParty2Address},
"sellerParty2ID" : {sellerParty2ID},
"sellerParty2Email" : {sellerParty2Email},
"sellerParty2HomePhone" :{sellerParty2HomePhone},
"sellerParty2WorkPhone" : {sellerParty2WorkPhone},
"sellerParty2CellPhone" : {sellerParty2CellPhone},
"sellerParty2Fax" : {sellerParty2Fax},
"sellerParty3Name" :{sellerParty3Name},
"sellerParty3Address" :{sellerParty3Address},
"sellerParty3ID" : {sellerParty3ID},
"sellerParty3Email" : {sellerParty3Email},
"sellerParty3HomePhone" :{sellerParty3HomePhone},
"sellerParty3WorkPhone" : {sellerParty3WorkPhone},
"sellerParty3CellPhone" : {sellerParty3CellPhone},
"sellerParty3Fax" : {sellerParty3Fax},
"sellerParty4Name" :{sellerParty4Name},
"sellerParty4Address" :{sellerParty4Address},
"sellerParty4ID" : {sellerParty4ID},
"sellerParty4Email" : {sellerParty4Email},
"sellerParty4HomePhone" :{sellerParty4HomePhone},
"sellerParty4WorkPhone" : {sellerParty4WorkPhone},
"sellerParty4CellPhone" : {sellerParty4CellPhone},
"sellerParty4Fax" : {sellerParty4Fax},
"sellerParty5Name" :{sellerParty5Name},
"sellerParty5Address" :{sellerParty5Address},
"sellerParty5ID" : {sellerParty5ID},
"sellerParty5Email" : {sellerParty5Email},
"sellerParty5HomePhone" :{sellerParty5HomePhone},
"sellerParty5WorkPhone" : {sellerParty5WorkPhone},
"sellerParty5CellPhone" : {sellerParty5CellPhone},
"sellerParty5Fax" : {sellerParty5Fax},
"sellerParty6Name" :{sellerParty6Name},
"sellerParty6Address" :{sellerParty6Address},
"sellerParty6ID" : {sellerParty6ID},
"sellerParty6Email" : {sellerParty6Email},
"sellerParty6HomePhone" :{sellerParty6HomePhone},
"sellerParty6WorkPhone" : {sellerParty6WorkPhone},
"sellerParty6CellPhone" : {sellerParty6CellPhone},
"sellerParty6Fax" : {sellerParty6Fax},
"sellerParty7Name" :{sellerParty7Name},
"sellerParty7Address" :{sellerParty7Address},
"sellerParty7ID" : {sellerParty7ID},
"sellerParty7Email" : {sellerParty7Email},
"sellerParty7HomePhone" :{sellerParty7HomePhone},
"sellerParty7WorkPhone" : {sellerParty7WorkPhone},
"sellerParty7CellPhone" : {sellerParty7CellPhone},
"sellerParty7Fax" : {sellerParty7Fax},
"sellerParty8Name" :{sellerParty8Name},
"sellerParty8Address" :{sellerParty8Address},
"sellerParty8ID" : {sellerParty8ID},
"sellerParty8Email" : {sellerParty8Email},
"sellerParty8HomePhone" :{sellerParty8HomePhone},
"sellerParty8WorkPhone" : {sellerParty8WorkPhone},
"sellerParty8CellPhone" : {sellerParty8CellPhone},
"sellerParty8Fax" : {sellerParty8Fax},
"sellerBrokerageName": {sellerBrokerageName},
"sellerBrokerageAddress": {sellerBrokerageAddress},
"sellerBrokeragePhone":{sellerBrokeragePhone},
"sellerBrokerageFax": {sellerBrokerageFax},
"sellerBrokerageID": {sellerBrokerageID},
"sellerBrokerName": {sellerBrokerName},
"sellerBrokerID": {sellerBrokerID},
"sellerBrokerEmail": {sellerBrokerEmail},
"sellerAgentName": {sellerAgentName},
"sellerAgentID": {sellerAgentID},
"sellerAgentEmail": {sellerAgentEmail},
"sellerAgentWorkPhone": {sellerAgentWorkPhone},
"sellerAgentHomePhone": {sellerAgentHomePhone},
"sellerAgentCellPhone": {sellerAgentCellPhone},
"sellerAgentFaxNo": {sellerAgentFaxNo},
"sellerAgentNRDSID": {sellerAgentNRDSID},
"buyerLandlordName": {buyerLandlordName},
"buyerParty1Name" :{buyerParty1Name},
"buyerParty1Address" :{buyerParty1Address},
"buyerParty1ID" : {buyerParty1ID},
"buyerParty1Email" : {buyerParty1Email},
"buyerParty1HomePhone" :{buyerParty1HomePhone},
"buyerParty1WorkPhone" : {buyerParty1WorkPhone},
"buyerParty1CellPhone" : {buyerParty1CellPhone},
"buyerParty1Fax" : {buyerParty1Fax},
"buyerParty2Name" :{buyerParty2Name},
"buyerParty2Address" :{buyerParty2Address},
"buyerParty2ID" : {buyerParty2ID},
"buyerParty2Email" : {buyerParty2Email},
"buyerParty2HomePhone" :{buyerParty2HomePhone},
"buyerParty2WorkPhone" : {buyerParty2WorkPhone},
"buyerParty2CellPhone" : {buyerParty2CellPhone},
"buyerParty2Fax" : {buyerParty2Fax},
"buyerParty3Name" :{buyerParty3Name},
"buyerParty3Address" :{buyerParty3Address},
"buyerParty3ID" : {buyerParty3ID},
"buyerParty3Email" : {buyerParty3Email},
"buyerParty3HomePhone" :{buyerParty3HomePhone},
"buyerParty3WorkPhone" : {buyerParty3WorkPhone},
"buyerParty3CellPhone" : {buyerParty3CellPhone},
"buyerParty3Fax" : {buyerParty3Fax},
"buyerParty4Name" :{buyerParty4Name},
"buyerParty4Address" :{buyerParty4Address},
"buyerParty4ID" : {buyerParty4ID},
"buyerParty4Email" : {buyerParty4Email},
"buyerParty4HomePhone" :{buyerParty4HomePhone},
"buyerParty4WorkPhone" : {buyerParty4WorkPhone},
"buyerParty4CellPhone" : {buyerParty4CellPhone},
"buyerParty4Fax" : {buyerParty4Fax},
"buyerParty5Name" :{buyerParty5Name},
"buyerParty5Address" :{buyerParty5Address},
"buyerParty5ID" : {buyerParty5ID},
"buyerParty5Email" : {buyerParty5Email},
"buyerParty5HomePhone" :{buyerParty5HomePhone},
"buyerParty5WorkPhone" : {buyerParty5WorkPhone},
"buyerParty5CellPhone" : {buyerParty5CellPhone},
"buyerParty5Fax" : {buyerParty5Fax},
"buyerParty6Name" :{buyerParty6Name},
"buyerParty6Address" :{buyerParty6Address},
"buyerParty6ID" : {buyerParty6ID},
"buyerParty6Email" : {buyerParty6Email},
"buyerParty6HomePhone" :{buyerParty6HomePhone},
"buyerParty6WorkPhone" : {buyerParty6WorkPhone},
"buyerParty6CellPhone" : {buyerParty6CellPhone},
"buyerParty6Fax" : {buyerParty6Fax},
"buyerParty7Name" :{buyerParty7Name},
"buyerParty7Address" :{buyerParty7Address},
"buyerParty7ID" : {buyerParty7ID},
"buyerParty7Email" : {buyerParty7Email},
"buyerParty7HomePhone" :{buyerParty7HomePhone},
"buyerParty7WorkPhone" : {buyerParty7WorkPhone},
"buyerParty7CellPhone" : {buyerParty7CellPhone},
"buyerParty7Fax" : {buyerParty7Fax},
"buyerParty8Name" :{buyerParty8Name},
"buyerParty8Address" :{buyerParty8Address},
"buyerParty8ID" : {buyerParty8ID},
"buyerParty8Email" : {buyerParty8Email},
"buyerParty8HomePhone" :{buyerParty8HomePhone},
"buyerParty8WorkPhone" : {buyerParty8WorkPhone},
"buyerParty8CellPhone" : {buyerParty8CellPhone},
"buyerParty8Fax" : {buyerParty8Fax},
"buyerBrokerageName": {buyerBrokerageName},
"buyerBrokerageAddress": {buyerBrokerageAddress},
"buyerBrokeragePhone":{buyerBrokeragePhone},
"buyerBrokerageFax": {buyerBrokerageFax},
"buyerBrokerageID": {buyerBrokerageID},
"buyerBrokerName": {buyerBrokerName},
"buyerBrokerID": {buyerBrokerID},
"buyerBrokerEmail": {buyerBrokerEmail},
"buyerAgentName": {buyerAgentName},
"buyerAgentID": {buyerAgentID},
"buyerAgentEmail": {buyerAgentEmail},
"buyerAgentWorkPhone": {buyerAgentWorkPhone},
"buyerAgentHomePhone": {buyerAgentHomePhone},
"buyerAgentCellPhone": {buyerAgentCellPhone},
"buyerAgentFaxNo": {buyerAgentFaxNo},
"buyerAgentNRDSID": {buyerAgentNRDSID},
"escrowCompanyRepresents": {escrowCompanyRepresents},
"escrowAgent": {escrowAgent},
"escrowCompanyName": {escrowCompanyName},
"escrowCompanyAddress": {escrowCompanyAddress},
"escrowEmailAddress":{escrowEmailAddress},
"escrowPhone": {escrowPhone},
"escrowFax": {escrowFax},
"titleCompanyRepresents": {titleCompanyRepresents},
"titleAgent": {titleAgent},
"titleCompanyName": {titleCompanyName},
"titleCompanyAddress": {titleCompanyAddress},
"titleEmailAddress": {titleEmailAddress},
"titlePhone": {titlePhone},
"titleFax": {titleFax},
"title2CompanyRepresents": {title2CompanyRepresents},
"title2Agent":{title2Agent},
"title2CompanyName": {title2CompanyName},
"title2CompanyAddress": {title2CompanyAddress},
"title2EmailAddress": {title2EmailAddress},
"title2Phone": {title2Phone},
"title2Fax": {title2Fax},
"lendingCompanyRepresents": {lendingCompanyRepresents},
"lendingAgent": {lendingAgent},
"lendingCompanyName": {lendingCompanyName},
"lendingCompanyAddress": {lendingCompanyAddress},
"lendingEmailAddress": {lendingEmailAddress},
"lendingPhone": {lendingPhone},
"lendingFax": {lendingFax},
"closingCompanyRepresents": {closingCompanyRepresents},
"closingAgent": {closingAgent},
"closingCompanyName":{closingCompanyName},
"closingCompanyAddress": {closingCompanyAddress},
"closingEmailAddress": {closingEmailAddress},
"closingPhone": {closingPhone},
"closingFax": {closingFax},
"propertyAppraisalCompanyRepresents": {propertyAppraisalCompanyRepresents},
"propertyAppraisalCompanyName": {propertyAppraisalCompanyName},
"propertyAppraisalCompanyAddress": {propertyAppraisalCompanyAddress},
"propertyAppraisalEmailAddress": {propertyAppraisalEmailAddress},
"propertyAppraisalPhone": {propertyAppraisalPhone},
"propertyAppraisalFax": {propertyAppraisalFax},
"inspectionCompanyRepresents": {inspectionCompanyRepresents},
"inspectionAgent": {inspectionAgent},
"inspectionCompanyName": {inspectionCompanyName},
"inspectionCompanyAddress": {inspectionCompanyAddress},
"inspectionEmailAddress": {inspectionEmailAddress},
"inspectionPhone": {inspectionPhone},
"inspectionFax": {inspectionFax},
"transId" " {transId}
}
]
Response: ERROR
| Error Code | Error Type |
|---|---|
| 400 Bad Request | Missing Required Parameter |
| 401 Unauthorized | Access Denied |
| 402 Bad Request | Invalid Character found in {parameter value} |
| 403 New Transaction Failure | Transaction creation failed: {error reason} |
See
Exception Documentation
for more details
FS Upload Files
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/uploadfiles
Request Body
{
"userId" : {vendorEmailId}
"transId" : {transId},
"file_name" : {file to be uploaded},
"description" : {Description about the file},
"sender" : {Sender Company},
"no_of_pages" : {No. of Pages in the file}
Response: SUCCESS
Response Body
"status": 200,
"result": "Success",
"Message": {File uploaded successfully.}
Response: ERROR
| Error Code | Error Type |
|---|---|
| 400 Bad Request | Missing Required Parameter |
| 401 Unauthorized | Access Denied |
| 402 Bad Request | Invalid Character found in {parameter value} |
| 412 File Failure | Invalid File Type. Accepted File Types are pdf, xls, jpg, doc |
| 413 File Upload Failure | SoapFault:{Error} |
See
Exception Documentation
for more details
FS Download Files
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/downloadfiles
Request Body
{
"userId" : {vendorEmailId}
"transId" : {transId}
"filter" : {filter}
}
format: filter=<filtervalue>
[optional] filter: fileFolderID=<fileFolderID>, fileID=<fileID>, insertDate=<timestamp>, lastUpdateDate=<timestamp>,
insertDate_min=<timestamp>, lastUpdateDate_since=<timestamp>
** Please make sure that the filter values are enclosed in <> and the parameters are separated by commas.
Response: SUCCESS
Response Body
"status": 200,
"result": "Success",
"file_url": {fileURL. Single file / multiple files(zip) download}
Response: ERROR
| Error Code | Error Type |
|---|---|
| 400 Bad Request | Missing Required Parameter |
| 401 Unauthorized | Access Denied |
| 402 Bad Request | Invalid Character found in {parameter value} |
See
Exception Documentation
for more details
FS Add Service Providers
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/serviceproviders
Request Body
{
"userId" : {vendorEmailId}
"agentNRDSID" : {agentNRDSID},
"transId" : {transId},
"data" : {ServiceProvidersData in json}
}
The following JSON format is accepted:
[
{
"spType":"ESCROW",
"Represents": "Buyer",
"Company": "Escrow Company",
"AgentName":"Escrow Agent",
"CompanyAddress": "Escrow Company Addr",
"Email": "email@escrowcomp.com",
"Phone": "8882346232"
},
{
"spType":"CLOSING",
"Represents": "",
"Company": "ClosingCompany",
"AgentName":"Closing Agent",
"CompanyAddress": "Closing Company Addr",
"Email": "email@closingcomp.com" ,
"Fax": "8772341234"
}
]
Schema is given in https://formsapidev.floridarealtors.org/ServiceProvidersSchema.json
Response: SUCCESS
Response Body
"Success"
Response: ERROR
| Error Code | Error Type |
|---|---|
| 400 Bad Request | Missing Required Parameter |
| 401 Unauthorized | Access Denied |
| 402 Bad Request | Invalid Character found in {parameter value} |
| 411 | Unexpected Value in the parameter |
See
Exception Documentation
for more details
FS List Files
Request: POST
POST https://formsapidev.floridarealtors.org/fsforms/listFiles
Request Body
{
"userId" : {vendorEmailId}
"transId" : {transId}
"filter" : {filter}
}
format: filter=<filtervalue>
[optional] filter: fileFolderID=<fileFolderID>, fileID=<fileID>, insertDate=<timestamp>, lastUpdateDate=<timestamp>,
insertDate_min=<timestamp>, lastUpdateDate_since=<timestamp>
** Please make sure that the filter values are enclosed in <> and the parameters are separated by commas.
Response: SUCCESS
Response Body
{
"meta": {
"total": {total transaction files},
},
"data": [
{
"fileFolderID" : {fileFolderID},
"fileID" : {fileID},
"fileName" : {fileName},
"fileDescription" : {fileDescription},
"insertDate" : {insertDate},
"lastUpdateDate" : {lastUpdateDate},
},...
]
}
Response: ERROR
| Error Code | Error Type |
|---|---|
| 400 Bad Request | Missing Required Parameter |
| 401 Unauthorized | Access Denied |
| 402 Bad Request | Invalid Character found in {parameter value} |
| 404 Bad Request | Invalid Filter:{parameter value} |
See
Exception Documentation
for more details