Raynix Developer Portal

Introduction

Welcome to the Raynix Property API — a powerful interface for third-party integrations with the Raynix property management system. This API allows authorized partners to:

Authenticate securely using JWT tokens
Create, update, delete, and reactivate property listings
Manage property status (Available, Sold, and Rented.)
Manage property media type (images and videos.)
Retrieve consistent responses for integration monitoring

All endpoints use JSON and secure Bearer token authorization.

Overview

Base URLs used by endpoints in this portal.

BASE_URL_AUTH = https://authorisation-test.raynix.uk/api/Auth
BASE_URL = https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ

Authentication

Authenticate a user and receive a JWT token. Note this base URL differs from the AgentIQ endpoints.

POST

https://authorisation-test.raynix.uk/api/Auth/login

Headers

Accept: */*
Content-Type: application/json

Payload

cURL example

{
  "username": "apitesting@raynix.uk",
  "password": "Hp_AscPVRPogaeWpRJwgnCNh017_NMgPl6ymTgvdBguD1EFuZXRcNWTLNAeEHE7-"
}

Success Response (200)

{
  "status": {
    "responseCode": "00",
    "responseMessage": "Successful"
  },
  "token": "eyJ......",
  "expiresIn": 15777600
}

Failure Response (Invalid Username)

{
  "status": {
    "responseCode": "09",
    "responseMessage": "Invalid Username"
  },
  "expiresIn": 0
}

Add Property

Create a new property listing with metadata and media.

POST

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/AddProperty

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "487374",
  "title": "Three Bedroom flat",
  "address": "LU1 3UT",
  "price": 1100,
  "bedrooms": 3,
  "bathrooms": 1,
  "area": "127",
  "description": "Three Bedroom flat",
  "agentCode": "06745d25-47af-47f8-9918-a37a4004714e",
  "status": "Rent",
  "sellingPrice": 0,
  "postCode": "LU1 3UT",
  "country": "United Kingdom",
  "media": [
    {
      "mediaId": "LU14USK-02",
      "type": "image",
      "url": "https://example.com/photo1.jpg"
    }
  ]
}

curl -X 'POST' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/AddProperty' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "487374", "title": "Three Bedroom flat", "address": "LU1 3UT", "price": 1100, "bedrooms": 3, "bathrooms": 1, "area": "127", "description": "Three Bedroom flat", "agentCode": "06745d25-47af-47f8-9918-a37a4004714e", "status": "Rent", "sellingPrice": 0, "postCode": "LU1 3UT", "country": "United Kingdom", "media": [{ "mediaId": "LU14USK-02", "type": "image", "url": "https://example.com/photo1.jpg" }] }'

Success Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Failure Response (422)

{
  "responseCode": "01",
  "responseMessage": "Failed"
}

Update Property

Update details of an existing property (by reference number).

PUT

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/UpdateProperty

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "4873756",
  "title": "Three Bedroom flat",
  "address": "LU1 3UT",
  "price": 1200,
  "bedrooms": 3,
  "bathrooms": 2,
  "area": "127",
  "description": "Three Bedroom flat",
  "agentCode": "06745d25-47af-47f8-9918-a37a4004714e",
  "status": "Rent",
  "sellingPrice": 0,
  "postCode": "LU1 3UT",
  "country": "United Kingdom",
  "isStudentAllowed": true,
  "isPensionerAllowed": true,
  "isRentAvailable": true,
  "isSaleAvailable": true,
  "media": [
    {
      "mediaId": "LU14USK-06",
      "type": "image",
      "url": "https://example.com/photo11.jpg"
    }
  ]
}

curl -X 'PUT' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/UpdateProperty' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "4873756", "title": "Three Bedroom flat", "address": "LU1 3UT", "price": 1200, "bedrooms": 3, "bathrooms": 2, "area": "127", "description": "Three Bedroom flat", "agentCode": "06745d25-47af-47f8-9918-a37a4004714e", "status": "Rent", "sellingPrice": 0, "postCode": "LU1 3UT", "country": "United Kingdom", "isStudentAllowed": true, "isPensionerAllowed": true, "isRentAvailable": true, "isSaleAvailable": true, "media": [{ "mediaId": "LU14USK-06", "type": "image", "url": "https://example.com/photo11.jpg" }] }'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Lock Property

Lock a property by its property reference number (path parameter).

DELETE

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/{propertreferencenumber}

cURL Example

curl -X 'DELETE' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/4873759' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Reactivate Property

Reactivate a previously lock property via its reference number.

PUT

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivateProperty

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "4873759"
}

curl -X 'PUT' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivateProperty' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "4873759" }'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Lock Property Media

Lock a media item attached to a property (path parameters: property reference number and mediaId).

DELETE

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/{propertreferencenumber}/media/{mediaId}

Example cURL

curl -X 'DELETE' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/properties/4873759/media/LU14USK-08' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}

Reactivate Property Media

Reactivate a lock media item for a property.

PUT

https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivatePropertyMedia

Headers

Accept: */*
Authorization: Bearer <JWT_TOKEN>
Content-Type: application/json

{
  "propertiesReferenceNumber": "4873759",
  "mediaId": "LU14USK-08"
}

curl -X 'PUT' 'https://thirdparyagent-test.raynix.uk/api/ThirdPartyAgentIQ/ReactivatePropertyMedia' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "propertiesReferenceNumber": "4873759", "mediaId": "LU14USK-08" }'

Response (200)

{
  "responseCode": "00",
  "responseMessage": "Successful"
}