Available Methods

Create a Document/Floorplan

POST https://www.relahq.com/api/v1/object/document/

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

Request Body

Name	Type	Description
show_on_unbranded	Bool	Whether to show this document on unbranded site
title*	String	The title of the document
property_reference*	String	The nid of the property this document is assigned to
file_url*	String	An accessible URL address of the document
category	String	Category for the document
visible	Bool	Whether the document is visible on the website
is_floorplan	Bool	Whether this document is a floor plan or not

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "nid": 12345,
}

Update a Document/Floorplan

PUT https://www.relahq.com/api/v1/object/document/{nid}

Example request for updating document visibility.

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
content-type*	String	application/json
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token

Request Body

Name	Type	Description
visible	Bool	Whether the document is visible on the website

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    "nid": "9876",
}

Retrieve a Document/Floorplan

GET https://www.relahq.com/api/v1/object/document/{nid}

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token
content-type*	String	application/json

Request Body

Name	Type	Description
visible	Bool	Whether the document is visible on the website

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "nid": "9876",
  "created": 1640032564,
  "changed": 1640032564,
  "title":  "Document Title",
  "property_reference": 12354,
  "file_url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
  "visible": TRUE,
  "category": "category string",
  "is_floorplan":  TRUE,
  "Show_on_unbranded": TRUE,

}

Delete a Document/Floorplan

DELETE https://www.relahq.com/api/v1/object/document/{nid}

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    [true],
}