Florida Realtors API

Endpoint: /auth

Used for validating and registering members.

FR Authentication

Request: POST

POST https://api-dev.floridarealtors.org/auth/frauth

Parameter	Type
userId (required)	string
password (required)	string

Response: SUCCESS

{
  "return": {return},
  "stateId": {stateId},
  "sessionId": {sessionId},
  "userType": {userType},
  "firstName": {firstName},
  "lastName": {lastName},
  "email": {email},
  "message": {message},
  "userSubType": {userSubType},
  "addresss1": {addresss1},
  "address2": {address2},
  "city": {city},
  "state": {state},
  "zipCode": {zipCode},
  "zipPlus4": {zipPlus4},
  "phoneNum": {phoneNum},
  "licenseNum": {licenseNum},
  "nrdsId": {nrdsId},
  "boards": {boards},
  "firmId": {firmId},
  "firmAddress1": {firmAddress1},
  "firmAddress2": {firmAddress2},
  "firmCity": {firmCity},
  "firmState": {firmState},
  "firmZipCode": {firmZipCode},
  "firmZipPlus4": {firmZipPlus4},
  "firmPhoneNum": {firmPhoneNum},
  "firmLicenseNum": {firmLicenseNum},
  "firmName": {firmName},
  "firmFax": {firmFax},
  "firmEmail": {firmEmail},
  "firmNrdsId": {firmNrdsId},
  "firmBoards": {firmBoards},
  "services": {services},
  "realtorId": {realtorId},
  "committeeCodes": {committeeCodes}
}

Response: ERROR

Error Code	Error Type
401 Unauthorized	Access Denied
400 Bad Request	Missing Required Parameter

See Exception Documentation for more details

FR SSO Authentication

Request: POST

POST https://api-dev.floridarealtors.org/auth/frssoauth

Parameter	Type
sessionKey (required)	string
userId (required)	string

Response: SUCCESS

{
  "return": {return},
  "stateId": {stateId},
  "sessionId": {sessionId},
  "userType": {userType},
  "firstName": {firstName},
  "lastName": {lastName},
  "email": {email},
  "message": {message},
  "userSubType": {userSubType},
  "addresss1": {addresss1},
  "address2": {address2},
  "city": {city},
  "state": {state},
  "zipCode": {zipCode},
  "zipPlus4": {zipPlus4},
  "phoneNum": {phoneNum},
  "licenseNum": {licenseNum},
  "nrdsId": {nrdsId},
  "boards": {boards},
  "firmId": {firmId},
  "firmAddress1": {firmAddress1},
  "firmAddress2": {firmAddress2},
  "firmCity": {firmCity},
  "firmState": {firmState},
  "firmZipCode": {firmZipCode},
  "firmZipPlus4": {firmZipPlus4},
  "firmPhoneNum": {firmPhoneNum},
  "firmLicenseNum": {firmLicenseNum},
  "firmName": {firmName},
  "firmFax": {firmFax},
  "firmEmail": {firmEmail},
  "firmNrdsId": {firmNrdsId},
  "firmBoards": {firmBoards},
  "services": {services},
  "realtorId": {realtorId},
  "committeeCodes": {committeeCodes}
}

Response: ERROR

Error Code	Error Type
401 Unauthorized	Access Denied
400 Bad Request	Missing Required Parameter

See Exception Documentation for more details

Find User By Name

Request: POST

POST https://api-dev.floridarealtors.org/auth/finduserbyname

Parameter	Type
firstName (required)	string
lastName (required)	string

Response: SUCCESS

[
  {
    "realtorId": {realtorId},
    "name": {name},
    "email": {email},
    "committeeCodes": {committeeCodes}
  }
]

Response: ERROR

Error Code	Error Type
401 Unauthorized	Access Denied
400 Bad Request	Missing Required Parameter

See Exception Documentation for more details