api-reference.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta
      name="description"
      content="The main page of the Real&Mate API Reference."
    />
    <meta
      name="keywords"
      content="real&mate, web application, documentation, api, reference, real estate, business, management, estate"
    />
  </head>

  <body style="display: none">
    <div id="container" class="theme">
      <nav>
        <nav-links-doc-main-page></nav-links-doc-main-page>
      </nav>
      <theme-button></theme-button>
      <speak-button></speak-button>
      <div id="header">
        <h1>
          <span class="title">API Reference</span><br />
          <span id="subtitle"></span>
        </h1>
        <logo-img></logo-img>
      </div>
    </div>

    <main>
      <!-- prettier-ignore -->
      <p class="text-center speak">
        Real&Mate’s API (Application Programming Interface) powers its business platform. Behind this API is a software layer connecting and optimizing communications networks around the world to allow your users to buy, sell and rent real estate.
      </p>

      <a href="pages/api-ref/api-glossary.html" class="list-link"
        >API Glossary</a
      >
      <a href="pages/api-ref/api-usage.html" class="list-link">API Usage</a>
      <a href="pages/api-ref/webhooks.html" class="list-link">Webhooks</a>

      <div id="methods">
        <details class="no-user-details">
          <summary>Application Management</summary>
          <ul>
            <li>
              <a href="pages/api-ref/app-mgmt/get-realandmate-v1.html"
                >Retrieve Information about the Application</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/app-mgmt/get-realandmate-v1-reboot-act-info.html"
                >Retrieve Information about Application Reboot Parameters</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/app-mgmt/get-realandmate-v1-acts-application-reboot.html"
                >Reboot the Application</a
              >
            </li>
            <li>
              <a href="pages/api-ref/app-mgmt/patch-realandmate-v1.html"
                >One-Time Override Boot Source</a
              >
            </li>
          </ul>
        </details>

        <details>
          <summary>Real Estate Management</summary>
          <ul>
            <li class="no-user">
              <a
                href="pages/api-ref/estate-mgmt/get-realandmate-v1-real-estate-service.html"
                >Retrieve Information about Real Estate Service Parameters</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/estate-mgmt/get-realandmate-v1-real-estate-service-objects.html"
                >Retrieve the Real Estate Object Collection</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/estate-mgmt/get-realandmate-v1-real-estate-service-objects-object-id.html"
                >Retrieve Information about a Specific Real Estate Object</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/estate-mgmt/post-realandmate-v1-real-estate-service-objects.html"
                >Create a Real Estate Object</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/estate-mgmt/delete-realandmate-v1-real-estate-service-objects-object-id.html"
                >Delete a Real Estate Object</a
              >
            </li>
          </ul>
        </details>

        <details>
          <summary>Advertisement Management</summary>
          <ul>
            <li>
              <a
                href="pages/api-ref/advertisement-mgmt/get-realandmate-v1-advertisement-service-advertisements.html"
                >Retrieve the Real Estate Advertisement Collection</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/advertisement-mgmt/post-realandmate-v1-advertisement-service-advertisements.html"
                >Create an Advertisement</a
              >
            </li>
          </ul>
        </details>

        <details class="no-user-details">
          <summary>Application Logging</summary>
          <ul>
            <li>
              <a
                href="pages/api-ref/app-log/get-realandmate-v1-log-service.html"
                >Retrieve the Application Log Entry Collection</a
              >
            </li>
          </ul>
        </details>

        <details>
          <summary>Agency Management</summary>
          <ul>
            <li>
              <a
                href="pages/api-ref/agency-mgmt/get-realandmate-v1-agency-service-agencies.html"
                >Retrieve the Application Agency Collection</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/agency-mgmt/post-realandmate-v1-agency-service-agencies.html"
                >Add an Agency</a
              >
            </li>
          </ul>
        </details>

        <details class="no-user-details">
          <summary>Account Management</summary>
          <ul>
            <li>
              <a
                href="pages/api-ref/account-mgmt/get-realandmate-v1-account-service.html"
                >Retrieve Information about Account Management Settings</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/account-mgmt/patch-realandmate-v1-account-service.html"
                >Update Account Management Settings</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/account-mgmt/get-realandmate-v1-account-service-accounts.html"
                >Retrieve the Application Account Collection</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/account-mgmt/get-realandmate-v1-account-service-accounts-username.html"
                >Retrieve Information about an Account</a
              >
            </li>
          </ul>
        </details>

        <details class="no-user-details">
          <summary>Role Management</summary>
          <ul>
            <li>
              <a
                href="pages/api-ref/role-mgmt/get-realandmate-v1-role-service-roles.html"
                >Retrieve the Application Role Collection</a
              >
            </li>
            <li>
              <a
                href="pages/api-ref/role-mgmt/get-realandmate-v1-role-service-roles-role-name.html"
                >Retrieve Information about a Role</a
              >
            </li>
          </ul>
        </details>
      </div>

      <div id="w3c">
        <a
          href="https://jigsaw.w3.org/css-validator/validator?uri=https%3A%2F%2Fprimesolar.github.io%2Fdocs%2Fapi-reference.html&profile=css3svg&usermedium=all&warning=no&vextwarning=&lang=en"
          target="_blank"
          rel="noopener noreferrer"
          id="w3c-text"
        >
          Verified by World Wide Web Consortium:&nbsp;
        </a>
        <a
          href="https://jigsaw.w3.org/css-validator/validator?uri=https%3A%2F%2Fprimesolar.github.io%2Fdocs%2Fapi-reference.html&profile=css3svg&usermedium=all&warning=no&vextwarning=&lang=en"
          target="_blank"
          rel="noopener noreferrer"
          id="w3c-img"
        >
          <img id="w3c-img"
        /></a>
      </div>
    </main>

    <div id="footerContainer"></div>

    <script src="scripts/components-title-min.js"></script>
    <script src="scripts/dark-theme-min.js"></script>
    <script src="scripts/p-1-line-indent-min.js"></script>
    <script src="scripts/ripples-min.js"></script>
    <script src="scripts/menu-min.js"></script>
    <script src="scripts/speak-min.js"></script>
    <script src="scripts/components-min.js"></script>
    <script src="scripts/meta-tags-min.js"></script>
  </body>
</html>