Finera Platform API Reference

Complete REST/JSON API reference for all platform services. Click any endpoint to expand code examples in 7 languages.

Getting Started

Step 1 — Request Your API Key

All Finera Platform API calls are authenticated with a signed JSON Web Token (JWT) issued by the Finera team. To obtain a key, send an email to founder@fineratech.com with the following information:

Subject line: Finera API Access Request

Include in your email:
• Organization name — your company or project name
• Use case — what you intend to build or integrate with the Finera API
• Technical contact — name and email of the developer who will receive and use the token
• Access level — ReadOnly (data queries only) or ReadWrite (data mutations included)
• Services needed — Customer Service, Resource Service, or both

The Finera team will review your request and respond within 2 business days with your provisioned JWT token.

Step 2 — Authenticate Every Request

Once your token is issued, pass it as the FINERA-API-KEY HTTP header on every API request. The value is the full JWT string you received — a long dot-separated string beginning with eyJ.... Keep the token secret and never embed it in client-side code or public repositories.

Security notice: Treat your API token like a password. It is tied to your organization and all usage is logged. If you believe your token has been compromised, contact founder@fineratech.com immediately for revocation. Revocation takes effect within 5 minutes platform-wide.

Making Your First Authenticated Request

# Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
# This call hits the health-check endpoint and confirms your token is accepted.

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

# HTTP 200 — authenticated successfully
# HTTP 401 — token is missing, expired, or revoked
# HTTP 403 — token lacks permission for this service or endpoint

import requests

# Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
API_TOKEN = "YOUR_FINERA_JWT_TOKEN"
CI_BASE   = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc"
RS_BASE   = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc"

# Attach the token to a shared headers dict and reuse it on every call.
headers = {"FINERA-API-KEY": API_TOKEN}

# Ping the health-check endpoint to confirm authentication
response = requests.get(f"{CI_BASE}/GetDataSimple", headers=headers)
response.raise_for_status()   # raises HTTPError on 4xx / 5xx
print(response.json())

# Reuse headers on every subsequent call:
# requests.get(f"{CI_BASE}/GetUser/alice@example.com", headers=headers)
# requests.post(f"{RS_BASE}/...", json={...}, headers=headers)

// Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
const API_TOKEN = "YOUR_FINERA_JWT_TOKEN";
const CI_BASE   = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc";
const RS_BASE   = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc";

// Attach the token once; reuse the headers object on every call.
const headers = {
  "FINERA-API-KEY": API_TOKEN,
  "Content-Type":  "application/json"
};

// Ping the health-check endpoint to confirm authentication
const res = await fetch(`${CI_BASE}/GetDataSimple`, { headers });
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

// Reuse headers on every subsequent call:
// await fetch(`${CI_BASE}/GetUser/alice@example.com`, { headers });
// await fetch(`${RS_BASE}/...`, { method: "POST", headers, body: JSON.stringify({...}) });

using System.Net.Http;
using System.Net.Http.Headers;

// Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
const string API_TOKEN = "YOUR_FINERA_JWT_TOKEN";
const string CI_BASE   = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/";
const string RS_BASE   = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/";

// Reuse a single HttpClient for the lifetime of your application.
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", API_TOKEN);
client.DefaultRequestHeaders.Accept.Add(
    new MediaTypeWithQualityHeaderValue("application/json"));

// Ping the health-check endpoint to confirm authentication
var response = await client.GetAsync(CI_BASE + "GetDataSimple");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

// All subsequent calls through this client automatically include the header:
// await client.GetAsync(CI_BASE + "GetUser/alice@example.com");
// await client.PostAsJsonAsync(RS_BASE + "...", payload);

// Using OkHttp 4.x
import okhttp3.*;

// Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
private static final String API_TOKEN = "YOUR_FINERA_JWT_TOKEN";
private static final String CI_BASE   = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc";
private static final String RS_BASE   = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc";

// Build an OkHttpClient that injects the header via an interceptor on every request.
OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(chain -> {
        Request original = chain.request();
        Request authenticated = original.newBuilder()
            .header("FINERA-API-KEY", API_TOKEN)
            .build();
        return chain.proceed(authenticated);
    })
    .build();

// Ping the health-check endpoint to confirm authentication
Request request = new Request.Builder()
    .url(CI_BASE + "/GetDataSimple")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

// Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
define('FINERA_API_KEY', 'YOUR_FINERA_JWT_TOKEN');
define('CI_BASE', 'https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/');
define('RS_BASE', 'https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/');

/**
 * Make an authenticated GET request to a Finera API endpoint.
 * Returns ['body' => string, 'code' => int].
 */
function finera_get(string $url): array {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_TIMEOUT, 30);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'FINERA-API-KEY: ' . FINERA_API_KEY,
        'Accept: application/json',
    ]);
    $body = curl_exec($ch);
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);
    return ['body' => $body, 'code' => $code];
}

// Ping the health-check endpoint to confirm authentication
$result = finera_get(CI_BASE . 'GetDataSimple');
if ($result['code'] === 200) {
    print_r(json_decode($result['body'], true));
} else {
    echo "Error HTTP " . $result['code'] . ": " . $result['body'];
}
?>

require "net/http"
require "uri"
require "json"

# Replace YOUR_FINERA_JWT_TOKEN with the full JWT string issued to you.
API_TOKEN = "YOUR_FINERA_JWT_TOKEN"
CI_BASE   = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc"
RS_BASE   = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc"

# Helper: authenticated GET request
def finera_get(path, base = CI_BASE)
  uri = URI.parse("#{base}/#{path}")
  req = Net::HTTP::Get.new(uri)
  req["FINERA-API-KEY"] = API_TOKEN
  req["Accept"]         = "application/json"
  Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |h| h.request(req) }
end

# Ping the health-check endpoint to confirm authentication
response = finera_get("GetDataSimple")
puts JSON.parse(response.body)

# Reuse finera_get on every subsequent call:
# finera_get("GetUser/alice@example.com")
# finera_get("GetCapacity/resourceId/123", RS_BASE)

Token Claims & Permissions

Your JWT contains the following claims that control what the token is permitted to do. The Finera team configures these at issuance based on your requested access level. To request a change to your token's permissions, contact founder@fineratech.com.

Claim	Possible Values	Description
AuthorizedServices	`All` \| `CustomerServiceAuthorization` \| `ResourceServiceAuthorization` \| `PayfacServiceAuthorization`	Which service(s) the token may call. Exclusion syntax is supported: `All,-PayfacServiceAuthorization` = all services except Payfac. HTTP 403 is returned when this service is not covered.
AuthorizedAccount	`ReadOnly` \| `ReadWrite`	ReadOnly: GET requests only — POST/PUT/DELETE return HTTP 403. ReadWrite: all HTTP methods permitted.
AuthorizedOperations	`` \| `GetUser,ValidateUser` \| `,-GetUser`	Which endpoint operations the token may invoke. `` = all operations. A comma-separated list restricts to those operations only. Exclusion syntax `,-Op1,-Op2` = all except the listed operations. HTTP 403 is returned for any blocked operation.
IssuedTo	e.g. `Acme Corp Integration`	Your organization label as provided at token request time. Appears in platform audit logs alongside every API call made with this token.
TokenId	integer	Internal platform ID used for revocation and auditing. You do not need to use this value in your integration.

Token expiry & renewal: Tokens are valid for 365 days from issuance by default. Email founder@fineratech.com before your token expires to request a renewal. Your existing token will continue to work until its expiry date even after a new one is issued.

Base URLs

Customer Service — user identity, authentication, banking:
https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/

Resource Service — resources, scheduling, orders, commerce:
https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/

Your provisioning email will include the correct host and service reference paths. Both services accept the same FINERA-API-KEY token.

What are the reference paths?
Each service is hosted as a WCF endpoint under IIS. The reference path is the IIS virtual directory name combined with the .svc service file name. For example:

[CustomerServiceReferencePath] → e.g. CustomerInfoJson/CustomerInfoJsonService.svc
[ResourceServiceReferencePath] → e.g. SharingServiceJson/RSServiceJSON.svc

The virtual directory portion (before the /) is the IIS application alias configured on your server. The .svc filename is the WCF service file deployed inside that application. Both values are fixed for a given deployment and will be provided with your API credentials.

Response format: All responses are JSON. Endpoints marked Wrapped envelope the result in {"MethodResult": ...}; Bare returns the value directly. HTTP 401 = token missing, expired, or revoked. HTTP 403 = token lacks permission for this service or endpoint.

Agentic App Development (MCP)

The Finera platform exposes all API operations through a Model Context Protocol (MCP) server — a standard interface that allows any LLM-powered agent to discover and invoke platform operations as structured tool calls. Instead of writing custom HTTP integration code, you connect your AI model to the MCP server and describe what you need in natural language. The model calls the appropriate tools automatically.

MCP Server public endpoint: http://fineratech.com:8765/sse

Transport: SSE (Server-Sent Events) — the standard MCP transport for remote agents.
Protocol: Model Context Protocol (MCP) by Anthropic — supported by Claude Desktop, LangChain, OpenAI Agents SDK, Google ADK, and the open-source mcp Python SDK.

What the MCP server exposes:

Tools — 40+ callable operations (user management, resource search, service booking, scheduling, payments)
Resources — read-only data URIs (finera://resource/{id}, finera://service-status-map, etc.)
Workflow Prompts — pre-built multi-step agent instructions for common flows (find & book, provider onboarding, service fulfillment)

Access Token for MCP

The MCP server uses the same JWT token system as the REST API. However, the token is used differently depending on your role:

Role	Token Usage
MCP Server Admin (whoever hosts the server)	Issues a single JWT token from the Finera admin UI and places it in the server’s `.env` file as `FINERA_API_TOKEN`. This token authenticates all outbound WCF service calls the MCP server makes on behalf of agents.
Agent Developer (you, building an agentic app)	Connects to the public SSE endpoint. No per-client authentication is required today. Optionally include your `FINERA-API-KEY` JWT in the SSE connection headers to receive a dedicated rate-limit bucket (otherwise you share a lower anonymous limit with your IP). A token will be required for standard-tier and higher access as enforcement rolls out — see the rate limit table below.

Rate Limit Tiers

Tier	How Identified	Limit	How to Upgrade
Anonymous	IP address only (no `FINERA-API-KEY` header)	20 req / 60 s (planned)	Request a free token — see below
Authenticated	Valid `FINERA-API-KEY` JWT in header	60 req / 60 s	Email founder@fineratech.com for a custom limit

Getting your FINERA-API-KEY:
The same JWT token used for direct REST API access is also valid for the MCP server. Request one by emailing founder@fineratech.com with subject Finera API Access Request. Include your organization, use case, and desired access level (ReadOnly or ReadWrite). See the Getting Started section for full details. Tokens are provisioned within 2 business days.

Once you have a token, pass it as a header on your SSE connection to receive a dedicated rate-limit bucket and ensure uninterrupted service as anonymous-tier enforcement tightens.

Step 1 — Connect to the MCP Server

Install the MCP Python SDK and verify connectivity before building your agent:

Install SDK & Test Connection

# Install the MCP Python SDK (into your project venv)
pip install mcp httpx

# Quick connectivity test — should print the tool list
python -c "
import asyncio
from mcp import ClientSession
from mcp.client.sse import sse_client

async def test():
    async with sse_client('http://fineratech.com:8765/sse') as (r, w):
        async with ClientSession(r, w) as s:
            await s.initialize()
            tools = await s.list_tools()
            print(f'Connected. {len(tools.tools)} tools available.')
            for t in tools.tools[:5]:
                print(f'  - {t.name}: {t.description[:60]}')

asyncio.run(test())
"

import asyncio
from mcp import ClientSession
from mcp.client.sse import sse_client

MCP_URL = "http://fineratech.com:8765/sse"

# Optional: pass your API key as a header for rate-limit identity
headers = {"FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"}  # omit if not yet issued

async def connect():
    async with sse_client(MCP_URL, headers=headers) as (read, write):
        async with ClientSession(read, write) as session:
            await session.initialize()

            # List available tools
            tools = await session.list_tools()
            print(f"{len(tools.tools)} tools available")

            # List available resource URIs
            resources = await session.list_resources()
            for r in resources.resources:
                print(f"  Resource: {r.uri}")

            # List available workflow prompts
            prompts = await session.list_prompts()
            for p in prompts.prompts:
                print(f"  Prompt: {p.name}")

asyncio.run(connect())

Step 2 — Build an Agentic App with Claude (Anthropic)

Claude natively supports MCP tool calling. The example below connects to the Finera MCP server, fetches the tool list, and runs an agentic loop that lets Claude search for resources and book a service in response to a natural language request.

Install

pip install anthropic mcp httpx

Simple Agentic App — Claude

import asyncio, json
import anthropic
from mcp import ClientSession
from mcp.client.sse import sse_client

MCP_URL    = "http://fineratech.com:8765/sse"
CLAUDE_MDL = "claude-sonnet-4-6"   # or claude-opus-4-6 for most capable

async def run_agent(user_request: str):
    # 1. Connect to the Finera MCP server
    async with sse_client(MCP_URL) as (read, write):
        async with ClientSession(read, write) as mcp:
            await mcp.initialize()

            # 2. Fetch tool definitions and convert to Anthropic format
            mcp_tools = await mcp.list_tools()
            tools_for_claude = [
                {
                    "name": t.name,
                    "description": t.description,
                    "input_schema": t.inputSchema,
                }
                for t in mcp_tools.tools
            ]

            # 3. Send the user request to Claude with all Finera tools available
            client   = anthropic.Anthropic()
            messages = [{"role": "user", "content": user_request}]

            print(f"User: {user_request}\n")

            # 4. Agentic loop — Claude calls tools until it has a final answer
            while True:
                response = client.messages.create(
                    model=CLAUDE_MDL,
                    max_tokens=4096,
                    tools=tools_for_claude,
                    messages=messages,
                )

                # Collect all text and tool use blocks
                tool_calls   = [b for b in response.content if b.type == "tool_use"]
                text_blocks  = [b for b in response.content if b.type == "text"]

                if text_blocks:
                    for tb in text_blocks:
                        print(f"Claude: {tb.text}")

                # If Claude produced no tool calls, it is done
                if not tool_calls or response.stop_reason == "end_turn":
                    break

                # 5. Execute each tool call against the MCP server
                messages.append({"role": "assistant", "content": response.content})
                tool_results = []
                for tc in tool_calls:
                    print(f"  [Calling tool: {tc.name}({json.dumps(tc.input)[:80]}...)]")
                    result = await mcp.call_tool(tc.name, tc.input)
                    tool_results.append({
                        "type": "tool_result",
                        "tool_use_id": tc.id,
                        "content": result.content[0].text if result.content else "",
                    })

                messages.append({"role": "user", "content": tool_results})

# --- Run it ---
asyncio.run(run_agent(
    "Find available truck resources in Dallas, TX. "
    "Show me the first result with its capacity and daily rate."
))

Step 2 (alt) — Build an Agentic App with OpenAI

The OpenAI Agents SDK supports MCP servers directly via MCPServerSse. The MCP tool list is fetched automatically and exposed to the model as function calls.

Install

pip install openai-agents mcp httpx

Simple Agentic App — OpenAI Agents SDK

import asyncio
from agents import Agent, Runner
from agents.mcp import MCPServerSse

MCP_URL = "http://fineratech.com:8765/sse"

async def run_agent(user_request: str):
    # 1. Declare the Finera MCP server as a tool source
    async with MCPServerSse(url=MCP_URL) as finera_mcp:

        # 2. Create an agent with the MCP server attached
        agent = Agent(
            name="FineraAgent",
            instructions=(
                "You are a helpful assistant for the Finera resource-sharing platform. "
                "Use the available tools to answer questions about resources, users, "
                "and services. Always call get_service_status_transitions before "
                "transitioning a service status."
            ),
            mcp_servers=[finera_mcp],
        )

        # 3. Run the agent — tool discovery and execution are automatic
        result = await Runner.run(agent, user_request)
        print(result.final_output)

asyncio.run(run_agent(
    "Search for available RealEstate resources in Houston, TX "
    "and tell me about the first one."
))

Step 2 (alt) — Build an Agentic App with Google Gemini

Using Google’s Agent Development Kit (ADK), connect Gemini to the Finera MCP server. The ADK handles MCP tool discovery and the function-call loop automatically.

Install

pip install google-adk mcp httpx

Simple Agentic App — Gemini + Google ADK

import asyncio
from google.adk.agents import LlmAgent
from google.adk.tools.mcp_tool.mcp_toolset import MCPToolset, SseServerParams
from google.adk.runners import Runner
from google.adk.sessions import InMemorySessionService
from google.genai import types

MCP_URL = "http://fineratech.com:8765/sse"

async def run_agent(user_request: str):
    # 1. Create the MCP toolset pointing at the Finera SSE server
    finera_tools = MCPToolset(
        connection_params=SseServerParams(url=MCP_URL)
    )

    # 2. Define the Gemini agent
    agent = LlmAgent(
        model="gemini-2.0-flash",
        name="finera_agent",
        instruction=(
            "You are a Finera platform assistant. Use your tools to help users "
            "find and book resources, manage accounts, and track service requests."
        ),
        tools=[finera_tools],
    )

    # 3. Run the agent
    session_service = InMemorySessionService()
    session         = await session_service.create_session(
        app_name="finera_demo", user_id="demo_user"
    )
    runner = Runner(
        agent=agent,
        app_name="finera_demo",
        session_service=session_service,
    )

    user_msg = types.Content(
        role="user",
        parts=[types.Part(text=user_request)]
    )
    async for event in runner.run_async(
        user_id=session.user_id,
        session_id=session.id,
        new_message=user_msg,
    ):
        if event.is_final_response() and event.content:
            for part in event.content.parts:
                if part.text:
                    print(part.text)

asyncio.run(run_agent(
    "Show me vehicle resources available in Austin, TX."
))

Step 3 — Using Workflow Prompts for Multi-Step Flows

The Finera MCP server ships with pre-built Workflow Prompts — structured agent instructions that guide the model through multi-step platform flows. These are accessed via session.get_prompt() and should be used as the initial system or user message rather than writing your own instructions from scratch.

Prompt Name	Purpose	Key Arguments
`find_and_book_resource`	Find an available resource in a city and book a service end-to-end	category, city, state, customer_id
`register_new_provider`	Full provider onboarding: account, OTP, bank account, first resource listing	email, password, first_name, last_name, phone, resource_category, city, state
`service_fulfillment_workflow`	Guide a provider through fulfilling a service request (accept → schedule → complete)	service_id, provider_id
`user_onboarding`	Customer account setup: register, verify OTP, add payment, first search	email, password, first_name, last_name

Using a Workflow Prompt with Claude

import asyncio, json
import anthropic
from mcp import ClientSession
from mcp.client.sse import sse_client

MCP_URL = "http://fineratech.com:8765/sse"

async def run_workflow():
    async with sse_client(MCP_URL) as (read, write):
        async with ClientSession(read, write) as mcp:
            await mcp.initialize()

            # 1. Fetch a workflow prompt — this returns a structured message
            #    that tells the model exactly how to execute the workflow
            prompt_result = await mcp.get_prompt(
                "find_and_book_resource",
                {
                    "category":    "Truck",
                    "city":        "Dallas",
                    "state":       "TX",
                    "customer_id": "12345",
                }
            )

            # 2. Use the prompt messages as the starting context for Claude
            mcp_tools = await mcp.list_tools()
            tools_for_claude = [
                {"name": t.name, "description": t.description, "input_schema": t.inputSchema}
                for t in mcp_tools.tools
            ]

            # Convert MCP prompt messages to Anthropic message format
            messages = []
            for pm in prompt_result.messages:
                messages.append({
                    "role": pm.role,
                    "content": pm.content.text if hasattr(pm.content, "text") else str(pm.content),
                })

            client = anthropic.Anthropic()

            # 3. Run the agentic loop using the workflow prompt as context
            while True:
                response = client.messages.create(
                    model="claude-sonnet-4-6",
                    max_tokens=4096,
                    tools=tools_for_claude,
                    messages=messages,
                )

                tool_calls  = [b for b in response.content if b.type == "tool_use"]
                text_blocks = [b for b in response.content if b.type == "text"]

                for tb in text_blocks:
                    print(f"Agent: {tb.text}")

                if not tool_calls or response.stop_reason == "end_turn":
                    break

                messages.append({"role": "assistant", "content": response.content})
                tool_results = []
                for tc in tool_calls:
                    print(f"  [Tool: {tc.name}]")
                    result = await mcp.call_tool(tc.name, tc.input)
                    tool_results.append({
                        "type": "tool_result",
                        "tool_use_id": tc.id,
                        "content": result.content[0].text if result.content else "",
                    })
                messages.append({"role": "user", "content": tool_results})

asyncio.run(run_workflow())

Rate limiting: Authenticated agents (passing a valid FINERA-API-KEY header) receive 60 requests per 60-second window with a dedicated bucket. Anonymous agents (no token) will be subject to a lower shared limit as enforcement rolls out — see the rate limit tiers above. Always include your token header in production agents to avoid service interruptions. Contact founder@fineratech.com for a custom higher limit or to request a token.

Customer Service

User Lookup

GETGetDataSimpleHealth check / simple data endpoint

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetDataSimple")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetData/{value}Echo test endpoint

Parameter	Type	Description
value	string	Any test value

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetData/hello")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserId/{ContactEmail}Get the integer user ID for an email address

Parameter	Type	Description
ContactEmail	string	User email address

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserId/user@example.com")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUser/{ContactEmail}Get full User object by email address

Parameter	Type	Description
ContactEmail	string	User email address

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUser/user@example.com")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserByUserName/{username}Get User by username

Parameter	Type	Description
username	string	Username

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByUserName/john_doe")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserByCellPhoneNumber/{cellPhoneNumber}Get User by cell phone number

Parameter	Type	Description
cellPhoneNumber	string	Cell phone number

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByCellPhoneNumber/5551234567")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserByEmail/{userEmail}Get User by email (alternate endpoint)

Parameter	Type	Description
userEmail	string	User email address

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserByEmail/user@example.com")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserById/{ContactID}Get User by numeric contact ID

Parameter	Type	Description
ContactID	string	Numeric contact ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserById/12345")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTLoadUserInsert or update a User record

Parameter	Type	Description
(body)	User	Full User object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"FirstName\":\"John\",\"LastName\":\"Doe\",\"Email\":\"user@example.com\",\"UserName\":\"john_doe\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/LoadUser")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetUserOfType/{permissions}Get all users with a given permission type

Parameter	Type	Description
permissions	string	Permission type (Admin, Standard, Guest, Provider, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserOfType/Standard")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Registration

GETRegisterUser/{ContactEmail}/{strPassword}/{strFirstName}/{strLastName}Register a new user with basic info

Parameter	Type	Description
ContactEmail	string	Email address
strPassword	string	Password
strFirstName	string	First name
strLastName	string	Last name

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUser/user@example.com/SecurePass123/John/Doe")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterUserWithPhoneNumber/{ContactEmail}/{strPassword}/{strFirstName}/{strLastName}/{strPhone}Register a new user including phone number

Parameter	Type	Description
ContactEmail	string	Email address
strPassword	string	Password
strFirstName	string	First name
strLastName	string	Last name
strPhone	string	Cell phone number

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserWithPhoneNumber/user@example.com/SecurePass123/John/Doe/5551234567")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterUserNonRobust/{ContactEmail}/{strPassword}/{strFirstName}/{strLastName}Register a user (non-robust variant, bypasses some validation)

Parameter	Type	Description
ContactEmail	string	Email address
strPassword	string	Password
strFirstName	string	First name
strLastName	string	Last name

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserNonRobust/user@example.com/SecurePass123/John/Doe")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterUserDetailed/{strFirstName}/{strLastName}/{strUserName}/{strEmailAddress}/{strCellPhoneNumber}/{strCity}/{strState}/{strCountry}/{strPassword}/{strIsActive}Register a user with full address details (used by TruckLoad)

Parameter	Type	Description
strFirstName	string	First name
strLastName	string	Last name
strUserName	string	Username
strEmailAddress	string	Email address
strCellPhoneNumber	string	Cell phone number
strCity	string	City
strState	string	State
strCountry	string	Country
strPassword	string	Password
strIsActive	string	Whether account is active (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserDetailed/John/Doe/john_doe/user@example.com/5551234567/Seattle/WA/US/SecurePass123/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTRegisterUserAllPropertiesRegister a user with all User object properties

Parameter	Type	Description
(body)	User	Full User object with all properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe","Password":"SecurePass123","CellPhone":"5551234567","City":"Seattle","State":"WA","Country":"US"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe","Password":"SecurePass123","CellPhone":"5551234567","City":"Seattle","State":"WA","Country":"US"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe","Password":"SecurePass123","CellPhone":"5551234567","City":"Seattle","State":"WA","Country":"US"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe","Password":"SecurePass123","CellPhone":"5551234567","City":"Seattle","State":"WA","Country":"US"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"FirstName\":\"John\",\"LastName\":\"Doe\",\"Email\":\"user@example.com\",\"UserName\":\"john_doe\",\"Password\":\"SecurePass123\",\"CellPhone\":\"5551234567\",\"City\":\"Seattle\",\"State\":\"WA\",\"Country\":\"US\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe","Password":"SecurePass123","CellPhone":"5551234567","City":"Seattle","State":"WA","Country":"US"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterUserAllProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"FirstName":"John","LastName":"Doe","Email":"user@example.com","UserName":"john_doe","Password":"SecurePass123","CellPhone":"5551234567","City":"Seattle","State":"WA","Country":"US"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETRegisterNumber/{number}Register a phone number for OTP verification; returns user ID

Parameter	Type	Description
number	string	Phone number to register

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/RegisterNumber/5551234567")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETVerifyUser/{number}/{challenge}Verify a phone number with OTP challenge code

Parameter	Type	Description
number	string	Phone number
challenge	string	OTP code sent to user

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/VerifyUser/5551234567/123456")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETActivateUser/{number}Activate a user account by phone number

Parameter	Type	Description
number	string	Phone number

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ActivateUser/5551234567")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Authentication

GETValidateUser/{ContactEmail}/{strPassword}Validate credentials; returns ContactID (int) on success, -1 on failure

Parameter	Type	Description
ContactEmail	string	Email address
strPassword	string	Password

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUser/user@example.com/SecurePass123")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETValidateUserJson/{ContactEmail}/{strPassword}Validate credentials; returns JSON-wrapped string result

Parameter	Type	Description
ContactEmail	string	Email address
strPassword	string	Password

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ValidateUserJson/user@example.com/SecurePass123")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServicesPreviouslyValidatedWith/{ContactEmail}/{Password}Get list of services the user has previously authenticated with

Parameter	Type	Description
ContactEmail	string	Email address
Password	string	Password

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetServicesPreviouslyValidatedWith/user@example.com/SecurePass123")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTtestEcho test endpoint for StatusReturn object

Parameter	Type	Description
(body)	StatusReturn	Status object to echo back

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Status":"OK","Message":"Test message"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Status":"OK","Message":"Test message"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Status":"OK","Message":"Test message"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Status":"OK","Message":"Test message"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Status\":\"OK\",\"Message\":\"Test message\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Status":"OK","Message":"Test message"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/test")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Status":"OK","Message":"Test message"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

OTP / Challenge

GETOTP/{strEmailPhone}/{strPhoneOrEmail}Send a one-time password to the user

Parameter	Type	Description
strEmailPhone	string	Phone number or email address
strPhoneOrEmail	string	Type: phone or email

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTP/5551234567/phone")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETOTPChallenge/{strPhoneOrEmail}/{isEmail}Generate an OTP challenge (returns OTP — NOTE: security risk, see code comment)

Parameter	Type	Description
strPhoneOrEmail	string	Phone number or email address
isEmail optional	string	true if using email, false for phone

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/OTPChallenge/user@example.com/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAcceptOTPChallenge/{strPhoneOrEmail}/{otp}Validate an OTP challenge response

Parameter	Type	Description
strPhoneOrEmail	string	Phone number or email address
otp	string	One-time password to validate

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AcceptOTPChallenge/user@example.com/654321")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Profile Management

POSTUpdateUserUpdate a user record via full User object

Parameter	Type	Description
(body)	User	Updated User object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ContactID":12345,"FirstName":"John","LastName":"Smith","Email":"user@example.com"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ContactID":12345,"FirstName":"John","LastName":"Smith","Email":"user@example.com"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ContactID":12345,"FirstName":"John","LastName":"Smith","Email":"user@example.com"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ContactID":12345,"FirstName":"John","LastName":"Smith","Email":"user@example.com"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ContactID\":12345,\"FirstName\":\"John\",\"LastName\":\"Smith\",\"Email\":\"user@example.com\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ContactID":12345,"FirstName":"John","LastName":"Smith","Email":"user@example.com"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUser")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ContactID":12345,"FirstName":"John","LastName":"Smith","Email":"user@example.com"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETUpdateUserDetailed/{strUserId}/{strFirstName}/{strLastName}/{strUserName}/{strEmailAddress}/{strCellPhoneNumber}/{strAddress}/{strAptNumber}/{strCity}/{strState}/{strCountry}Update user profile fields individually

Parameter	Type	Description
strUserId	string	User ID
strFirstName	string	First name
strLastName	string	Last name
strUserName	string	Username
strEmailAddress	string	Email address
strCellPhoneNumber	string	Cell phone
strAddress	string	Street address
strAptNumber	string	Apt/unit number
strCity	string	City
strState	string	State
strCountry	string	Country

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserDetailed/12345/John/Doe/john_doe/user@example.com/5551234567/123 Main St/Apt 4B/Seattle/WA/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETUpdateUserAddress/{strType}/{strUserId}/{strAddress}/{strAptNumber}/{strCity}/{strState}/{strZipCode}/{strCountry}Update the address for a user

Parameter	Type	Description
strType	string	Address type (Home, Work, etc.)
strUserId	string	User ID
strAddress	string	Street address
strAptNumber	string	Apt number
strCity	string	City
strState	string	State
strZipCode	string	Zip code
strCountry	string	Country

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateUserAddress/Home/12345/123 Main St/4B/Seattle/WA/98101/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETContactUs/{strName}/{strContactNumber}/{strEmail}/{strQuery}Submit a contact us inquiry

Parameter	Type	Description
strName	string	Sender name
strContactNumber	string	Phone number
strEmail	string	Email address
strQuery	string	Message or query

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ContactUs/John Doe/5551234567/user@example.com/I need help with my account")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETDeleteUserByEmail/{strEmail}Delete a user account by email address

Parameter	Type	Description
strEmail	string	Email address

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByEmail/user@example.com")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETDeleteUserByPhone/{strPhoneNumber}Delete a user account by phone number

Parameter	Type	Description
strPhoneNumber	string	Phone number

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteUserByPhone/5551234567")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Bank Accounts

POSTAddBankAccountInfoAdd bank account via BankAccountInfo object

Parameter	Type	Description
(body)	BankAccountInfo	Bank account information object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"DDAType":"Checking","ACHType":"PPD","AccountNumber":"123456789","RoutingNumber":"021000021","CustomerID":"12345"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"DDAType":"Checking","ACHType":"PPD","AccountNumber":"123456789","RoutingNumber":"021000021","CustomerID":"12345"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"DDAType":"Checking","ACHType":"PPD","AccountNumber":"123456789","RoutingNumber":"021000021","CustomerID":"12345"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"DDAType":"Checking","ACHType":"PPD","AccountNumber":"123456789","RoutingNumber":"021000021","CustomerID":"12345"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"DDAType\":\"Checking\",\"ACHType\":\"PPD\",\"AccountNumber\":\"123456789\",\"RoutingNumber\":\"021000021\",\"CustomerID\":\"12345\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"DDAType":"Checking","ACHType":"PPD","AccountNumber":"123456789","RoutingNumber":"021000021","CustomerID":"12345"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountInfo")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"DDAType":"Checking","ACHType":"PPD","AccountNumber":"123456789","RoutingNumber":"021000021","CustomerID":"12345"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETAddBankAccount/{DDAType}/{ACHType}/{AccountNumber}/{RoutingNumber}/{MID}/{CustomerID}Add bank account via URL parameters

Parameter	Type	Description
DDAType	string	Checking or Savings
ACHType	string	ACH type (PPD, CCD, etc.)
AccountNumber	string	Bank account number
RoutingNumber	string	Bank routing number
MID	string	Merchant ID
CustomerID	string	Customer ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccount/Checking/PPD/123456789/021000021/MID001/12345")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddBankAccountDetailed/{BankId}/{DDAType}/{ACHType}/{AccountNumber}/{RoutingNumber}/{MID}/{CustomerID}Add bank account with bank ID specified

Parameter	Type	Description
BankId	string	Bank identifier
DDAType	string	Checking or Savings
ACHType	string	ACH type
AccountNumber	string	Account number
RoutingNumber	string	Routing number
MID	string	Merchant ID
CustomerID	string	Customer ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankAccountDetailed/BNK001/Checking/PPD/123456789/021000021/MID001/12345")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserBankAccounts/{customerId}Get all bank accounts for a customer

Parameter	Type	Description
customerId	string	Customer ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserBankAccounts/12345")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBankAccountInfoByCustomerID/{customerId}Get full BankAccountInfo records for a customer

Parameter	Type	Description
customerId	string	Customer ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByCustomerID/12345")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBankAccountInfoByAccountID/{AccountID}Get a single BankAccountInfo by account ID

Parameter	Type	Description
AccountID	string	Bank account ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankAccountInfoByAccountID/67890")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

PUTUpdateBankAccountInfoUpdate an existing bank account record

Parameter	Type	Description
(body)	BankAccountInfo	Updated BankAccountInfo object

Code Examples

curl -X PUT "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"AccountID":"67890","DDAType":"Savings","RoutingNumber":"021000021"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"AccountID":"67890","DDAType":"Savings","RoutingNumber":"021000021"}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"AccountID":"67890","DDAType":"Savings","RoutingNumber":"021000021"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo",
  {
    method: "PUT",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"AccountID":"67890","DDAType":"Savings","RoutingNumber":"021000021"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PutAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"AccountID\":\"67890\",\"DDAType\":\"Savings\",\"RoutingNumber\":\"021000021\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .put(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
$payload = {"AccountID":"67890","DDAType":"Savings","RoutingNumber":"021000021"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankAccountInfo")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Put.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"AccountID":"67890","DDAType":"Savings","RoutingNumber":"021000021"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteBankAccountInfo/{id}Delete a bank account by ID

Parameter	Type	Description
id	string	Bank account record ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankAccountInfo/67890")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Bank Cards

GETAddBankCardDetailed/{CustomerID}/{CardType}/{CardNumber}/{ExpirationMonth}/{ExpirationYear}/{CVSNumber}/{NameOnCard}/{LocationId}Add a bank/credit card with full details

Parameter	Type	Description
CustomerID	string	Customer ID
CardType	string	Card type (Visa, MasterCard, etc.)
CardNumber	string	Card number
ExpirationMonth	string	Expiry month (MM)
ExpirationYear	string	Expiry year (YYYY)
CVSNumber	string	CVV/CVS security code
NameOnCard	string	Name as printed on card
LocationId optional	string	Location ID (default 0)

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCardDetailed/12345/Visa/4111111111111111/12/2027/123/John Doe/0")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTAddBankCardsAdd a bank card via BankCards object

Parameter	Type	Description
(body)	BankCards	Bank card object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CustomerID":"12345","CardType":"Visa","CardNumber":"4111111111111111","ExpirationMonth":"12","ExpirationYear":"2027"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CustomerID":"12345","CardType":"Visa","CardNumber":"4111111111111111","ExpirationMonth":"12","ExpirationYear":"2027"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CustomerID":"12345","CardType":"Visa","CardNumber":"4111111111111111","ExpirationMonth":"12","ExpirationYear":"2027"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CustomerID":"12345","CardType":"Visa","CardNumber":"4111111111111111","ExpirationMonth":"12","ExpirationYear":"2027"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CustomerID\":\"12345\",\"CardType\":\"Visa\",\"CardNumber\":\"4111111111111111\",\"ExpirationMonth\":\"12\",\"ExpirationYear\":\"2027\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CustomerID":"12345","CardType":"Visa","CardNumber":"4111111111111111","ExpirationMonth":"12","ExpirationYear":"2027"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankCards")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CustomerID":"12345","CardType":"Visa","CardNumber":"4111111111111111","ExpirationMonth":"12","ExpirationYear":"2027"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetBankCards/{customerId}Get all bank cards for a customer

Parameter	Type	Description
customerId	string	Customer ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCards/12345")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBankCardById/{cardID}Get a specific bank card by card ID

Parameter	Type	Description
cardID	string	Bank card ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetBankCardById/99001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

PUTUpdateBankCardUpdate a bank card record

Parameter	Type	Description
(body)	BankCards	Updated BankCards object

Code Examples

curl -X PUT "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CardID":"99001","ExpirationMonth":"06","ExpirationYear":"2028"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CardID":"99001","ExpirationMonth":"06","ExpirationYear":"2028"}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CardID":"99001","ExpirationMonth":"06","ExpirationYear":"2028"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard",
  {
    method: "PUT",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CardID":"99001","ExpirationMonth":"06","ExpirationYear":"2028"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PutAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CardID\":\"99001\",\"ExpirationMonth\":\"06\",\"ExpirationYear\":\"2028\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .put(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
$payload = {"CardID":"99001","ExpirationMonth":"06","ExpirationYear":"2028"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdateBankCard")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Put.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CardID":"99001","ExpirationMonth":"06","ExpirationYear":"2028"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteBankCard/{id}Delete a bank card by ID

Parameter	Type	Description
id	string	Bank card ID

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/DeleteBankCard/99001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Bank Names

POSTAddBankNamesAdd a bank name record via BankNames object

Parameter	Type	Description
(body)	BankNames	Bank name object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"BankName":"Chase Bank"}'

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"BankName":"Chase Bank"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"BankName":"Chase Bank"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"BankName":"Chase Bank"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"BankName\":\"Chase Bank\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"BankName":"Chase Bank"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNames")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"BankName":"Chase Bank"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETAddBankNamesDetailed/{BankName}Add a bank name by string parameter

Parameter	Type	Description
BankName	string	Name of the bank

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/AddBankNamesDetailed/Chase Bank")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllBankNamesRetrieve all registered bank names

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetAllBankNames")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Password Management

GETGetUserPassword/{strEmail}Retrieve the stored password for a user (plain text)

Parameter	Type	Description
strEmail	string	User email address

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/GetUserPassword/user@example.com")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETForgotPassword/{strEmail}Trigger forgot-password flow (sends email)

Parameter	Type	Description
strEmail	string	User email address

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/ForgotPassword/user@example.com")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETUpdatePassword/{strEmail}/{strCurrentPassword}/{strNewPassword}Change a user password

Parameter	Type	Description
strEmail	string	User email address
strCurrentPassword	string	Current password
strNewPassword	string	New password

Code Examples

curl "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[CustomerServiceReferencePath].svc/UpdatePassword/user@example.com/OldPass123/NewPass456")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Resource Service

Capacity

GETtest2Health check endpoint

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/test2")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetData/{value}Echo test

Parameter	Type	Description
value	string	Test value

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetData/hello")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetCapacity/{capacityID}/{useCache}Get capacity record by ID; useCache=true uses MemoryCache

Parameter	Type	Description
capacityID	string	Capacity record ID
useCache optional	string	Use cache (true/false, default true)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCapacity/1001/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetCapacityCreate a new capacity record; returns new record ID

Parameter	Type	Description
(body)	Capacity	Capacity object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":100,"MaxCapacity":50,"CurrentCapacity":20,"Unit":"seats"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":100,"MaxCapacity":50,"CurrentCapacity":20,"Unit":"seats"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":100,"MaxCapacity":50,"CurrentCapacity":20,"Unit":"seats"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":100,"MaxCapacity":50,"CurrentCapacity":20,"Unit":"seats"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":100,\"MaxCapacity\":50,\"CurrentCapacity\":20,\"Unit\":\"seats\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":100,"MaxCapacity":50,"CurrentCapacity":20,"Unit":"seats"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCapacity")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":100,"MaxCapacity":50,"CurrentCapacity":20,"Unit":"seats"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateCapacityUpdate an existing capacity record

Parameter	Type	Description
(body)	Capacity	Updated Capacity object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CapacityID":1001,"MaxCapacity":60,"CurrentCapacity":25}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CapacityID":1001,"MaxCapacity":60,"CurrentCapacity":25}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CapacityID":1001,"MaxCapacity":60,"CurrentCapacity":25};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CapacityID":1001,"MaxCapacity":60,"CurrentCapacity":25};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CapacityID\":1001,\"MaxCapacity\":60,\"CurrentCapacity\":25}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CapacityID":1001,"MaxCapacity":60,"CurrentCapacity":25};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCapacity")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CapacityID":1001,"MaxCapacity":60,"CurrentCapacity":25}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetOwnedResourceCountOfType/{ownerId}/{Category}/{Type}Count owned resources of a specific category and type

Parameter	Type	Description
ownerId	string	Owner user ID
Category	string	Resource category
Type	string	Resource type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCountOfType/500/RealEstate/Apartment")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedResourceIdsOfType/{ownerId}/{Category}/{Type}Get list of resource IDs owned by user filtered by category and type

Parameter	Type	Description
ownerId	string	Owner user ID
Category	string	Resource category
Type	string	Resource type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIdsOfType/500/RealEstate/Apartment")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedResourceIds/{ownerId}Get all resource IDs owned by user

Parameter	Type	Description
ownerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceIds/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Resource Collections

GETGetOwnedResourceCollection/{ownerId}Get all resource collections owned by user

Parameter	Type	Description
ownerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollection/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedResourceCollectionCount/{idOwner}Count resource collections owned by user

Parameter	Type	Description
idOwner	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionCount/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/{idOwner}/{offset}/{RowCountToBeFetched}Paginated list of owned resource collections

Parameter	Type	Description
idOwner	string	Owner user ID
offset	string	Starting row offset
RowCountToBeFetched	string	Number of rows to fetch

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceCollectionForAGivenOffsetAndRowsToBeRetrieved/500/0/20")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllResourcesInAResourceCollection/{rcID}Get a ResourceCollection with all its resources loaded

Parameter	Type	Description
rcID	string	Resource collection ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourcesInAResourceCollection/200")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllChildResources/{parentId}Get all child resources of a parent resource

Parameter	Type	Description
parentId	string	Parent resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/300")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllChildResourceIds/{parentId}Get IDs of all child resources

Parameter	Type	Description
parentId	string	Parent resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/300")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBorrowedResourceCollection/{ownerId}Get resource collections currently borrowed by user

Parameter	Type	Description
ownerId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollection/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetLentResourceCollection/{ownerId}Get resource collections currently lent by user

Parameter	Type	Description
ownerId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResourceCollection/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBorrowedResourceCollectionCount/{ownerId}Count borrowed resource collections

Parameter	Type	Description
ownerId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResourceCollectionCount/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNeededResourceCollectionCount/{ownerId}Count needed resource collections

Parameter	Type	Description
ownerId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollectionCount/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNeededResourceCollection/{ownerId}Get resource collections marked as needed

Parameter	Type	Description
ownerId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNeededResourceCollection/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllNeededResourceCollectionsGet all needed resource collections platform-wide

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllNeededResourceCollections")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedSharedResources/{ownerId}Get shared resource collections owned by user

Parameter	Type	Description
ownerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedSharedResources/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetSharedResources/{ownerId}Get resource collections shared with a user

Parameter	Type	Description
ownerId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSharedResources/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsCountCount all available resource collections platform-wide

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsCount")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsGet all available resource collections

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollections")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/{offset}/{RowCountToBeFetched}Paginated available resource collections

Parameter	Type	Description
offset	string	Starting row offset
RowCountToBeFetched	string	Rows to fetch

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenOffsetAndRowCountToBeFeteched/0/20")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsForGivenTime/{startTime}/{endTime}Available collections within a time window

Parameter	Type	Description
startTime	string	Start time (ticks or ISO string)
endTime	string	End time

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTime/2024-01-01/2024-12-31")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsOfAGivenType/{strType}Available collections of a specific resource type

Parameter	Type	Description
strType	string	Resource type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsOfAGivenType/Apartment")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsInAGivenCity/{strCity}/{strState}Available collections in a city/state

Parameter	Type	Description
strCity	string	City name
strState	string	State code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenCity/Seattle/WA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsInAGivenState/{strState}Available collections in a state

Parameter	Type	Description
strState	string	State code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenState/WA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsInAGivenLocation/{locationId}Available collections at a specific location

Parameter	Type	Description
locationId	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsInAGivenLocation/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTGetAllAvailableResourceCollectionsForGivenTimeAndLocation/{startTime}/{endTime}Available collections for a time window and location (Location in body)

Parameter	Type	Description
startTime	string	Start time
endTime	string	End time
(body)	Location	Location object to filter by

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"City":"Seattle","State":"WA","Country":"US"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"City":"Seattle","State":"WA","Country":"US"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"City":"Seattle","State":"WA","Country":"US"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"City":"Seattle","State":"WA","Country":"US"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"City\":\"Seattle\",\"State\":\"WA\",\"Country\":\"US\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"City":"Seattle","State":"WA","Country":"US"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenTimeAndLocation/2024-01-01/2024-12-31")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"City":"Seattle","State":"WA","Country":"US"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetAllAvailableResourceCollectionsForGivenSchedule/{scheduleId}Available collections matching a schedule

Parameter	Type	Description
scheduleId	string	Schedule ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableResourceCollectionsForGivenSchedule/600")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTGetBorrowedResourcesGet borrowed resource collection for a user (User in body)

Parameter	Type	Description
(body)	User	User object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ContactID":500}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ContactID":500}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ContactID":500};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ContactID":500};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ContactID\":500}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ContactID":500};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowedResources")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ContactID":500}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceCollectionByResourceId/{resourceId}Get the resource collection that contains a specific resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCollectionByResourceId/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTInsertResourceCollectionInsert a new resource collection

Parameter	Type	Description
(body)	ResourceCollection	ResourceCollection object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"FriendlyName":"My Collection","OwnerId":500}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"FriendlyName":"My Collection","OwnerId":500}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"FriendlyName":"My Collection","OwnerId":500};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"FriendlyName":"My Collection","OwnerId":500};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"FriendlyName\":\"My Collection\",\"OwnerId\":500}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"FriendlyName":"My Collection","OwnerId":500};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollection")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"FriendlyName":"My Collection","OwnerId":500}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTInsertResourceCollectionSimple/{RCFriendlyName}Create a resource collection by name; returns new collection ID

Parameter	Type	Description
RCFriendlyName	string	Friendly name for the collection

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCollectionSimple/My New Collection")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceCollectionUpdate a resource collection

Parameter	Type	Description
(body)	ResourceCollection	Updated ResourceCollection

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCID":200,"FriendlyName":"Updated Name"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCID":200,"FriendlyName":"Updated Name"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCID":200,"FriendlyName":"Updated Name"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCID":200,"FriendlyName":"Updated Name"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCID\":200,\"FriendlyName\":\"Updated Name\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCID":200,"FriendlyName":"Updated Name"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollection")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCID":200,"FriendlyName":"Updated Name"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceCollectionInDatabaseUpdate a resource collection in the database

Parameter	Type	Description
(body)	ResourceCollection	ResourceCollection object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCID":200,"FriendlyName":"Updated Name"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCID":200,"FriendlyName":"Updated Name"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCID":200,"FriendlyName":"Updated Name"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCID":200,"FriendlyName":"Updated Name"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCID\":200,\"FriendlyName\":\"Updated Name\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCID":200,"FriendlyName":"Updated Name"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionInDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCID":200,"FriendlyName":"Updated Name"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSaveResourceCollectionInDatabaseSave a resource collection; returns updated collection

Parameter	Type	Description
(body)	ResourceCollection	ResourceCollection object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"FriendlyName":"My Collection","OwnerId":500}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"FriendlyName":"My Collection","OwnerId":500}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"FriendlyName":"My Collection","OwnerId":500};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"FriendlyName":"My Collection","OwnerId":500};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"FriendlyName\":\"My Collection\",\"OwnerId\":500}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"FriendlyName":"My Collection","OwnerId":500};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionInDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"FriendlyName":"My Collection","OwnerId":500}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSaveResourceCollectionMappingInDatabaseSave a resource collection mapping; returns mapping ID

Parameter	Type	Description
(body)	ResourceCollectionMapping	ResourceCollectionMapping object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCID":200,"ResourceID":1000,"Count":1}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCID":200,"ResourceID":1000,"Count":1}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCID":200,"ResourceID":1000,"Count":1};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCID":200,"ResourceID":1000,"Count":1};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCID\":200,\"ResourceID\":1000,\"Count\":1}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCID":200,"ResourceID":1000,"Count":1};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceCollectionMappingInDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCID":200,"ResourceID":1000,"Count":1}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceCollectionMappingInDatabaseUpdate a resource collection mapping

Parameter	Type	Description
(body)	ResourceCollectionMapping	ResourceCollectionMapping object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCID":200,"ResourceID":1000,"Count":2}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCID":200,"ResourceID":1000,"Count":2}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCID":200,"ResourceID":1000,"Count":2};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCID":200,"ResourceID":1000,"Count":2};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCID\":200,\"ResourceID\":1000,\"Count\":2}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCID":200,"ResourceID":1000,"Count":2};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCollectionMappingInDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCID":200,"ResourceID":1000,"Count":2}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTMapResourceToCollectionMap a resource to a collection

Parameter	Type	Description
(body)	ResourceCollectionMapping	Mapping object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCID":200,"ResourceID":1000,"Count":1}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCID":200,"ResourceID":1000,"Count":1}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCID":200,"ResourceID":1000,"Count":1};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCID":200,"ResourceID":1000,"Count":1};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCID\":200,\"ResourceID\":1000,\"Count\":1}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCID":200,"ResourceID":1000,"Count":1};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollection")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCID":200,"ResourceID":1000,"Count":1}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTMapResourceToCollectionSimple/{resourcecollectionID}/{resourceId}/{identicalresourceCount}Map a resource to a collection by IDs

Parameter	Type	Description
resourcecollectionID	string	Collection ID
resourceId	string	Resource ID
identicalresourceCount	string	Count of identical resources

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapResourceToCollectionSimple/200/1000/1")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceToCollectionMappingUpdate resource-to-collection mapping

Parameter	Type	Description
(body)	ResourceCollectionMapping	Updated mapping

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCID":200,"ResourceID":1000,"Count":3}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCID":200,"ResourceID":1000,"Count":3}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCID":200,"ResourceID":1000,"Count":3};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCID":200,"ResourceID":1000,"Count":3};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCID\":200,\"ResourceID\":1000,\"Count\":3}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCID":200,"ResourceID":1000,"Count":3};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceToCollectionMapping")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCID":200,"ResourceID":1000,"Count":3}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteResourceCollectionMapping/{RCId}/{resourceID}Remove a resource from a collection

Parameter	Type	Description
RCId	string	Resource collection ID
resourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceCollectionMapping/200/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Locations

POSTAddResourceLocationAdd a location for a resource (Location in body); returns location ID

Parameter	Type	Description
(body)	Location	Location object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Address":"123 Main St","City":"Seattle","State":"WA","Zip":"98101","Country":"US","Latitude":"47.6062","Longitude":"-122.3321"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Address":"123 Main St","City":"Seattle","State":"WA","Zip":"98101","Country":"US","Latitude":"47.6062","Longitude":"-122.3321"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Address":"123 Main St","City":"Seattle","State":"WA","Zip":"98101","Country":"US","Latitude":"47.6062","Longitude":"-122.3321"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Address":"123 Main St","City":"Seattle","State":"WA","Zip":"98101","Country":"US","Latitude":"47.6062","Longitude":"-122.3321"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Address\":\"123 Main St\",\"City\":\"Seattle\",\"State\":\"WA\",\"Zip\":\"98101\",\"Country\":\"US\",\"Latitude\":\"47.6062\",\"Longitude\":\"-122.3321\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Address":"123 Main St","City":"Seattle","State":"WA","Zip":"98101","Country":"US","Latitude":"47.6062","Longitude":"-122.3321"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddResourceLocation")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Address":"123 Main St","City":"Seattle","State":"WA","Zip":"98101","Country":"US","Latitude":"47.6062","Longitude":"-122.3321"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETAddLocationDetailed/{FriendlyName}/{Address}/{Apt}/{City}/{State}/{Zip}/{Country}/{Latitude}/{Longitude}Add a location with all address fields

Parameter	Type	Description
FriendlyName	string	Display name
Address	string	Street address
Apt	string	Apt/suite number
City	string	City
State	string	State
Zip	string	Zip code
Country	string	Country
Latitude	string	Latitude
Longitude	string	Longitude

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailed/Main Office/123 Main St/Suite 100/Seattle/WA/98101/US/47.6062/-122.3321")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddLocationDetailedWithCategorySubCategory/{Type}/{strCategory}/{strSubCategory}/{FriendlyName}/{Address}/{Apt}/{City}/{State}/{Zip}/{Country}/{Latitude}/{Longitude}Add a location with category and subcategory

Parameter	Type	Description
Type	string	Location type
strCategory	string	Category
strSubCategory	string	Sub-category
FriendlyName	string	Display name
Address	string	Street address
Apt	string	Apt/suite
City	string	City
State	string	State
Zip	string	Zip
Country	string	Country
Latitude	string	Latitude
Longitude	string	Longitude

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategory/Commercial/Office/Corporate/HQ Office/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddLocationDetailedWithCategorySubCategoryAndPurpose/{Type}/{strCategory}/{strSubCategory}/{FriendlyName}/{Address}/{Apt}/{City}/{State}/{Zip}/{Country}/{Latitude}/{Longitude}/{strPurpose}Add a location with category, subcategory, and purpose

Parameter	Type	Description
Type	string	Location type
strCategory	string	Category
strSubCategory	string	Sub-category
FriendlyName	string	Display name
Address	string	Street address
Apt	string	Apt/suite
City	string	City
State	string	State
Zip	string	Zip
Country	string	Country
Latitude	string	Latitude
Longitude	string	Longitude
strPurpose	string	Purpose of location

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationDetailedWithCategorySubCategoryAndPurpose/Commercial/Office/Corporate/HQ/123 Main St/Fl 5/Seattle/WA/98101/US/47.6062/-122.3321/Office")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddLocationMetaData/{LocationId}/{strPropertyName}/{strPropertyValue}Add metadata key/value to an existing location

Parameter	Type	Description
LocationId	string	Location ID
strPropertyName	string	Property name
strPropertyValue	string	Property value

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocationMetaData/400/Parking/Free")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTAddLocationAdd a location via Location object; returns string ID

Parameter	Type	Description
(body)	Location	Location object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Address":"456 Oak Ave","City":"Portland","State":"OR","Zip":"97201","Country":"US"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Address":"456 Oak Ave","City":"Portland","State":"OR","Zip":"97201","Country":"US"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Address":"456 Oak Ave","City":"Portland","State":"OR","Zip":"97201","Country":"US"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Address":"456 Oak Ave","City":"Portland","State":"OR","Zip":"97201","Country":"US"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Address\":\"456 Oak Ave\",\"City\":\"Portland\",\"State\":\"OR\",\"Zip\":\"97201\",\"Country\":\"US\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Address":"456 Oak Ave","City":"Portland","State":"OR","Zip":"97201","Country":"US"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLocation")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Address":"456 Oak Ave","City":"Portland","State":"OR","Zip":"97201","Country":"US"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateLocationUpdate an existing location

Parameter	Type	Description
(body)	Location	Updated Location object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"LocationID":400,"Address":"789 Pine St","City":"Seattle"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"LocationID":400,"Address":"789 Pine St","City":"Seattle"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"LocationID":400,"Address":"789 Pine St","City":"Seattle"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"LocationID":400,"Address":"789 Pine St","City":"Seattle"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"LocationID\":400,\"Address\":\"789 Pine St\",\"City\":\"Seattle\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"LocationID":400,"Address":"789 Pine St","City":"Seattle"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocation")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"LocationID":400,"Address":"789 Pine St","City":"Seattle"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETUpdateUserLocation/{UserId}/{LocationId}/{LocationType}Associate a location with a user

Parameter	Type	Description
UserId	string	User ID
LocationId	string	Location ID
LocationType	string	Location type (Home, Work, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateUserLocation/500/400/Home")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTAddUpdateLocationPropertyDetailed/{LocationId}/{InsightName}/{InsightValue}Add or update a named property on a location; returns property ID

Parameter	Type	Description
LocationId	string	Location ID
InsightName	string	Property name
InsightValue	string	Property value

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLocationPropertyDetailed/400/WiFi/Available")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetLocationPropertySet a location property via LocationProperty object

Parameter	Type	Description
(body)	LocationProperty	LocationProperty object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"LocationID":400,"PropertyName":"Parking","PropertyValue":"Free"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"LocationID":400,"PropertyName":"Parking","PropertyValue":"Free"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"LocationID":400,"PropertyName":"Parking","PropertyValue":"Free"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"LocationID":400,"PropertyName":"Parking","PropertyValue":"Free"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"LocationID\":400,\"PropertyName\":\"Parking\",\"PropertyValue\":\"Free\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"LocationID":400,"PropertyName":"Parking","PropertyValue":"Free"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperty")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"LocationID":400,"PropertyName":"Parking","PropertyValue":"Free"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetLocationPropertiesSet all location properties via Location object

Parameter	Type	Description
(body)	Location	Location object with properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"LocationID":400,"Properties":[{"Name":"Parking","Value":"Free"}]}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"LocationID":400,"Properties":[{"Name":"Parking","Value":"Free"}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"LocationID":400,"Properties":[{"Name":"Parking","Value":"Free"}]};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"LocationID":400,"Properties":[{"Name":"Parking","Value":"Free"}]};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"LocationID\":400,\"Properties\":[{\"Name\":\"Parking\",\"Value\":\"Free\"}]}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"LocationID":400,"Properties":[{"Name":"Parking","Value":"Free"}]};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetLocationProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"LocationID":400,"Properties":[{"Name":"Parking","Value":"Free"}]}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateLocationPropertiesUpdate location properties via Location object

Parameter	Type	Description
(body)	Location	Location object with updated properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"LocationID":400,"Properties":[{"Name":"WiFi","Value":"Yes"}]}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"LocationID":400,"Properties":[{"Name":"WiFi","Value":"Yes"}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"LocationID":400,"Properties":[{"Name":"WiFi","Value":"Yes"}]};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"LocationID":400,"Properties":[{"Name":"WiFi","Value":"Yes"}]};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"LocationID\":400,\"Properties\":[{\"Name\":\"WiFi\",\"Value\":\"Yes\"}]}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"LocationID":400,"Properties":[{"Name":"WiFi","Value":"Yes"}]};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"LocationID":400,"Properties":[{"Name":"WiFi","Value":"Yes"}]}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateLocationPropertyUpdate a single location property

Parameter	Type	Description
(body)	LocationProperty	LocationProperty to update

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"PropertyID":50,"LocationID":400,"PropertyName":"Parking","PropertyValue":"Paid"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"PropertyID":50,"LocationID":400,"PropertyName":"Parking","PropertyValue":"Paid"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"PropertyID":50,"LocationID":400,"PropertyName":"Parking","PropertyValue":"Paid"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"PropertyID":50,"LocationID":400,"PropertyName":"Parking","PropertyValue":"Paid"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"PropertyID\":50,\"LocationID\":400,\"PropertyName\":\"Parking\",\"PropertyValue\":\"Paid\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"PropertyID":50,"LocationID":400,"PropertyName":"Parking","PropertyValue":"Paid"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateLocationProperty")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"PropertyID":50,"LocationID":400,"PropertyName":"Parking","PropertyValue":"Paid"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteLocationProperty/{id}Delete a location property by ID

Parameter	Type	Description
id	string	Property ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocationProperty/50")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTGetLocationPropertiesGet all properties for a location (Location in body)

Parameter	Type	Description
(body)	Location	Location object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"LocationID":400}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"LocationID":400}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"LocationID":400};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"LocationID":400};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"LocationID\":400}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"LocationID":400};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"LocationID":400}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetLocationById/{locationid}Get full Location object by ID

Parameter	Type	Description
locationid	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLocationById/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceLocationById/{locationid}Get location object for a resource location

Parameter	Type	Description
locationid	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocationById/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceLocation/{resourceID}Get the location of a resource

Parameter	Type	Description
resourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceLocation/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedResourceLocations/{ownerId}Get all locations for resources owned by user

Parameter	Type	Description
ownerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResourceLocations/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUserLocations/{userid}Get all locations associated with a user

Parameter	Type	Description
userid	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUserLocations/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETMapAddressToUser/{userId}/{locationid}Associate an address/location with a user; returns mapping ID

Parameter	Type	Description
userId	string	User ID
locationid	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MapAddressToUser/500/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETDeleteLocation/{id}Delete a location by ID

Parameter	Type	Description
id	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteLocation/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

PayFac & Merchant Registration

GETRegisterPayFac/{strOwnerId}/{Category}/{Type}/{DBAName}/{MCC}/{BillingDescriptor}/{CustomerServiceContactEmail}/{CustomerServiceContactPhone}/{strLocationID}Register a PayFac (Payment Facilitator). Finera PayFacID: 34765.

Parameter	Type	Description
strOwnerId	string	Owner user ID
Category	string	Resource category (PayFac)
Type	string	Resource type (PayFac)
DBAName	string	Doing-business-as name
MCC	string	Merchant Category Code
BillingDescriptor	string	Billing descriptor on statements
CustomerServiceContactEmail	string	CS email
CustomerServiceContactPhone	string	CS phone
strLocationID	string	Location ID for the PayFac

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPayFac/29068/PayFac/PayFac/FINERA_LLC/8999/FINERA/support@finera.com/4258296006/4920")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterMerchant/{strOwnerId}/{Category}/{Type}/{DBAName}/{MCC}/{BillingDescriptor}/{PayFacTenancyID}/{PayFacID}/{CustomerServiceContactEmail}/{CustomerServiceContactPhone}/{strLocationID}Register a sub-merchant under a PayFac

Parameter	Type	Description
strOwnerId	string	Owner user ID
Category	string	Category
Type	string	Type
DBAName	string	DBA name
MCC	string	MCC code
BillingDescriptor	string	Billing descriptor
PayFacTenancyID	string	PayFac tenancy UUID
PayFacID	string	PayFac resource ID
CustomerServiceContactEmail	string	CS email
CustomerServiceContactPhone	string	CS phone
strLocationID	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchant/500/Merchant/SubMerchant/My Store LLC/5411/MYSTORE/0a1b1074-b79b-4f17-8511-f2146ade5171/34765/support@mystore.com/2065551234/4920")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterMerchantInPayFacDb/{resourceid}Register a merchant in the PayFac processor database

Parameter	Type	Description
resourceid	string	Merchant resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterMerchantInPayFacDb/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllPayFacsGet all registered PayFac records

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPayFacs")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllSubMerchants/{payfacId}Get all sub-merchants under a PayFac

Parameter	Type	Description
payfacId	string	PayFac resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllSubMerchants/34765")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetPayFac/{resourceId}Get PayFac details by resource ID

Parameter	Type	Description
resourceId	string	PayFac resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPayFac/34765")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetMerchant/{resourceID}Get merchant details by resource ID

Parameter	Type	Description
resourceID	string	Merchant resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchant/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetMerchantManagingResourceId/{resourceid}Get the merchant ID that manages a given resource

Parameter	Type	Description
resourceid	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantManagingResourceId/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Owner & Identity Registration

GETRegisterOwner/{resourceid}/{payfacdbmerchantid}/{strOwnerType}/{title}/{firstName}/{middlename}/{lastName}/{phoneNumber}/{phoneNumberExt}/{faxNumber}/{email}/{ownershipPercentage}/{ssn_or_itin}/{dobYear}/{dobMonth}/{dobDay}/{addressLine1}/{addressLine2}/{city}/{state}/{country}/{postalCode}/{postalCodeExtension}Register a beneficial/control owner for a merchant

Parameter	Type	Description
resourceid	string	Merchant resource ID
payfacdbmerchantid	string	PayFac DB merchant ID
strOwnerType	string	Owner type (BeneficialOwner, ControlOwner)
title	string	Title (Mr, Mrs, etc.)
firstName	string	First name
middlename	string	Middle name
lastName	string	Last name
phoneNumber	string	Phone number
phoneNumberExt	string	Phone extension
faxNumber	string	Fax number
email	string	Email address
ownershipPercentage	string	Ownership percentage (0-100)
ssn_or_itin	string	SSN or ITIN
dobYear	string	Date of birth year
dobMonth	string	Date of birth month
dobDay	string	Date of birth day
addressLine1	string	Address line 1
addressLine2	string	Address line 2
city	string	City
state	string	State
country	string	Country
postalCode	string	Postal code
postalCodeExtension	string	Postal code extension

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwner/1000/MER001/BeneficialOwner/Mr/John/A/Doe/5551234567/0/5557654321/john@business.com/51/123456789/1980/01/15/123 Main St//Seattle/WA/US/98101/0000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterOwnersIssuedIdentity/{ownerId}/{payfacdbmerchantid}/{idtype}/{idNumber}/{issuedCity}/{issuedState}/{issuedCountry}/{issuedYear}/{issuedMonth}/{issuedDay}/{expiryYear}/{expiryMonth}/{expiryDay}Register government-issued identity document for an owner

Parameter	Type	Description
ownerId	string	Owner resource ID
payfacdbmerchantid	string	PayFac DB merchant ID
idtype	string	ID type (passport, drivers_license, etc.)
idNumber	string	ID number
issuedCity	string	City of issue
issuedState	string	State of issue
issuedCountry	string	Country of issue
issuedYear	string	Issue year
issuedMonth	string	Issue month
issuedDay	string	Issue day
expiryYear	string	Expiry year
expiryMonth	string	Expiry month
expiryDay	string	Expiry day

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterOwnersIssuedIdentity/2000/MER001/passport/A1234567/Seattle/WA/US/2015/06/01/2025/06/01")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Entity Registration (Vehicle, Driver, Professional, Patient…)

GETRegisterRealEstate/{strOwnerId}/{Category}/{Type}/{locationId}/{strManagementCompanyId}/{Quantity}/{strStartingPreEmble}/{Capacity}/{strYear}/{Price}/{Rent}/{RentBillingCadence}/{Fees}/{FeesBillingCadence}/{Currency}Register a real estate resource

Parameter	Type	Description
strOwnerId	string	Owner user ID
Category	string	Category (RealEstate)
Type	string	Type (Apartment, House, etc.)
locationId	string	Location ID
strManagementCompanyId	string	Management company resource ID
Quantity	string	Number of units
strStartingPreEmble	string	Starting preamble/prefix
Capacity	string	Capacity
strYear	string	Year built
Price	string	Purchase price
Rent	string	Monthly rent
RentBillingCadence	string	Rent billing frequency
Fees	string	Additional fees
FeesBillingCadence	string	Fee billing frequency
Currency	string	Currency code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterRealEstate/500/RealEstate/Apartment/400/-1/1/APT/4/2020/500000/2500/Monthly/150/Monthly/USD")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterLeasee/{leaseeuserId}/{SSN}/{resourceLeasedId}/{Category}/{Type}/{strMerchantId}/{strIDType}/{strIDNumber}/{strIDIssueDate}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}Register a leasee/tenant for a real estate resource

Parameter	Type	Description
leaseeuserId	string	Leasee user ID
SSN	string	SSN
resourceLeasedId	string	Resource being leased
Category	string	Category
Type	string	Type
strMerchantId	string	Merchant/landlord resource ID
strIDType	string	ID type
strIDNumber	string	ID number
strIDIssueDate	string	ID issue date
strIDExpiryDate	string	ID expiry date
strIDIssuingState	string	ID issuing state
strIDIssuingCountry	string	ID issuing country

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterLeasee/500/123456789/1000/RealEstate/Apartment/800/drivers_license/D1234567/2018-01-01/2028-01-01/WA/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterVehicle/{strOwnerId}/{strLocationID}/{strRealEstateId}/{Category}/{Type}/{strMake}/{strModel}/{strYear}/{strColor}/{strPlateNumber}/{strState}Register a vehicle resource

Parameter	Type	Description
strOwnerId	string	Owner user ID
strLocationID	string	Home location ID
strRealEstateId	string	Associated real estate ID (-1 if none)
Category	string	Category (Vehicle)
Type	string	Type (Car, Truck, etc.)
strMake	string	Vehicle make
strModel	string	Vehicle model
strYear	string	Year
strColor	string	Color
strPlateNumber	string	License plate number
strState	string	License plate state

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterVehicle/500/400/-1/Vehicle/Car/Toyota/Camry/2022/Blue/ABC1234/WA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterTruck/{strOwnerId}/{Category}/{Type}/{strTruckingCompanyId}/{strIDType}/{strMake}/{strModel}/{strYear}/{strVIN}/{strLength}/{strRegistrationNumber}/{strRegistrationValidity}/{strPlateNumber}/{strInsuranceValidatyDate}/{strPortName}/{strPermitNumber}/{strPermitExpiryDate}Register a commercial truck resource

Parameter	Type	Description
strOwnerId	string	Owner user ID
Category	string	Category (Truck)
Type	string	Type (Flatbed, Dry Van, etc.)
strTruckingCompanyId	string	Trucking company resource ID
strIDType	string	Truck ID type
strMake	string	Make
strModel	string	Model
strYear	string	Year
strVIN	string	VIN number
strLength	string	Length in feet
strRegistrationNumber	string	Registration number
strRegistrationValidity	string	Registration valid until
strPlateNumber	string	License plate
strInsuranceValidatyDate	string	Insurance expiry date
strPortName	string	Port name (if applicable)
strPermitNumber	string	Permit number
strPermitExpiryDate	string	Permit expiry date

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTruck/500/Truck/DryVan/700/VIN/Freightliner/Cascadia/2021/1FUJHHDR1MLHB1234/53/REG123456/2025-12-31/TRK1234/2025-06-30/Port of Seattle/PERMIT001/2025-12-31")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterDriver/{strOwnerId}/{Category}/{Type}/{strTruckingCompanyId}/{strIDType}/{strIDNumber}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}/{strDrivingLicenseType}/{strDrivingLicenseNumber}/{strDLExpiryDate}/{strDLIssuingState}/{strDLIssuingCountry}Register a driver resource

Parameter	Type	Description
strOwnerId	string	Driver user ID
Category	string	Category (Driver)
Type	string	Type (CDL, etc.)
strTruckingCompanyId	string	Company resource ID
strIDType	string	Government ID type
strIDNumber	string	ID number
strIDExpiryDate	string	ID expiry date
strIDIssuingState	string	ID issuing state
strIDIssuingCountry	string	ID issuing country
strDrivingLicenseType	string	DL type (CDL Class A, etc.)
strDrivingLicenseNumber	string	Driving license number
strDLExpiryDate	string	DL expiry date
strDLIssuingState	string	DL issuing state
strDLIssuingCountry	string	DL issuing country

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDriver/500/Driver/CDL/700/passport/A1234567/2028-01-01/WA/US/CDL Class A/DL1234567/2026-01-01/WA/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterProfessional/{strOwnerId}/{Category}/{Type}/{strCompanyId}/{strIDType}/{strIDNumber}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}/{strLicenseType}/{strLicenseNumber}/{strExpiryDate}/{strIssuingState}/{strIssuingCountry}/{strGender}/{strDOB}/{strLocationId}Register a professional (doctor, lawyer, etc.)

Parameter	Type	Description
strOwnerId	string	Professional user ID
Category	string	Category (Professional)
Type	string	Type (Doctor, Lawyer, etc.)
strCompanyId	string	Company/hospital resource ID
strIDType	string	Gov ID type
strIDNumber	string	ID number
strIDExpiryDate	string	ID expiry
strIDIssuingState	string	ID state
strIDIssuingCountry	string	ID country
strLicenseType	string	Professional license type
strLicenseNumber	string	License number
strExpiryDate	string	License expiry
strIssuingState	string	License issuing state
strIssuingCountry	string	License issuing country
strGender	string	Gender
strDOB	string	Date of birth
strLocationId	string	Work location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessional/500/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterProfessionalWithDescription/{strOwnerId}/{strDescription}/{Category}/{Type}/{strCompanyId}/{strIDType}/{strIDNumber}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}/{strLicenseType}/{strLicenseNumber}/{strExpiryDate}/{strIssuingState}/{strIssuingCountry}/{strGender}/{strDOB}/{strLocationId}Register a professional with a description

Parameter	Type	Description
strOwnerId	string	Professional user ID
strDescription	string	Professional description/bio
Category	string	Category
Type	string	Type
strCompanyId	string	Company resource ID
strIDType	string	ID type
strIDNumber	string	ID number
strIDExpiryDate	string	ID expiry
strIDIssuingState	string	ID state
strIDIssuingCountry	string	ID country
strLicenseType	string	License type
strLicenseNumber	string	License number
strExpiryDate	string	License expiry
strIssuingState	string	License state
strIssuingCountry	string	License country
strGender	string	Gender
strDOB	string	DOB
strLocationId	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterProfessionalWithDescription/500/Board certified cardiologist/Professional/Doctor/700/passport/A1234567/2028-01-01/WA/US/Medical/LIC123456/2026-01-01/WA/US/Male/1975-05-20/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterClient/{strOwnerId}/{Category}/{Type}/{strCompanyId}/{strRecordFriendlyName}/{strClientRecordNumber}/{strIDType}/{strIDNumber}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}/{strGender}/{strDOB}/{strLocationId}Register a client record

Parameter	Type	Description
strOwnerId	string	Client user ID
Category	string	Category
Type	string	Type
strCompanyId	string	Company resource ID
strRecordFriendlyName	string	Friendly name
strClientRecordNumber	string	Client record number
strIDType	string	ID type
strIDNumber	string	ID number
strIDExpiryDate	string	ID expiry
strIDIssuingState	string	ID state
strIDIssuingCountry	string	ID country
strGender	string	Gender
strDOB	string	DOB
strLocationId	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterClient/500/Client/Individual/700/John Doe/CLT001/drivers_license/D1234567/2028-01-01/WA/US/Male/1985-03-15/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterPatient/{strOwnerId}/{Category}/{Type}/{strCompanyId}/{strMRN}/{strIDType}/{strIDNumber}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}/{strGender}/{strDOB}/{strLocationId}Register a patient in a healthcare system

Parameter	Type	Description
strOwnerId	string	Patient user ID
Category	string	Category (Patient)
Type	string	Type
strCompanyId	string	Hospital resource ID
strMRN	string	Medical record number
strIDType	string	ID type
strIDNumber	string	ID number
strIDExpiryDate	string	ID expiry
strIDIssuingState	string	ID state
strIDIssuingCountry	string	ID country
strGender	string	Gender
strDOB	string	DOB
strLocationId	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterPatient/500/Patient/Inpatient/700/MRN123456/passport/A1234567/2028-01-01/WA/US/Male/1970-07-04/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETProvideInsuranceInfo/{strPrimaryOrSecondary}/{patientId}/{isInsured}/{strInsuranceHolder}/{strPolicyHolderName}/{strInsuranceCompany}/{strIdNumber}/{strGroupNumber}Add insurance information for a patient

Parameter	Type	Description
strPrimaryOrSecondary	string	Primary or Secondary
patientId	string	Patient resource ID
isInsured	string	true/false
strInsuranceHolder	string	Insurance holder name
strPolicyHolderName	string	Policy holder name
strInsuranceCompany	string	Insurance company name
strIdNumber	string	Insurance ID number
strGroupNumber	string	Group number

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProvideInsuranceInfo/Primary/1000/true/John Doe/John Doe/BlueCross/INS123456/GRP001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterQasab/{strOwnerId}/{Category}/{Type}/{strIDType}/{strIDNumber}/{strIDExpiryDate}/{strIDIssuingState}/{strIDIssuingCountry}Register a Qasab (butcher) resource

Parameter	Type	Description
strOwnerId	string	User ID
Category	string	Category
Type	string	Type
strIDType	string	ID type
strIDNumber	string	ID number
strIDExpiryDate	string	ID expiry
strIDIssuingState	string	ID state
strIDIssuingCountry	string	ID country

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterQasab/500/Qasab/Halal/drivers_license/D1234567/2028-01-01/WA/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterDevice/{DeviceType}/{IMEI}/{SimNumber}/{Networkprovider}/{CallbackAPI}/{Region}/{Latitude}/{Longitude}Register an IoT/connected device

Parameter	Type	Description
DeviceType	string	Device type (EV, IoT, etc.)
IMEI	string	Device IMEI
SimNumber	string	SIM number
Networkprovider	string	Network provider
CallbackAPI	string	Callback API URL for notifications
Region	string	Region code
Latitude	string	Latitude
Longitude	string	Longitude

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDevice/EV/123456789012345/89012345678901234/T-Mobile/https://api.example.com/callback/US-NW/47.6062/-122.3321")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetProfessionalsOfACompany/{strCompanyID}/{strCategory}/{strType}Get professionals belonging to a company

Parameter	Type	Description
strCompanyID	string	Company resource ID
strCategory	string	Category filter
strType	string	Type filter

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetProfessionalsOfACompany/700/Professional/Doctor")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetIndependentProfessionals/{strType}Get independent (non-company) professionals by type

Parameter	Type	Description
strType	string	Professional type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentProfessionals/Doctor")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetPatients/{strType}/{strHospitalId}Get patients of a given type and hospital

Parameter	Type	Description
strType	string	Patient type
strHospitalId optional	string	Hospital resource ID (-1 for all)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPatients/Inpatient/-1")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetClients/{strType}/{strCompanyId}Get clients of a given type and company

Parameter	Type	Description
strType	string	Client type
strCompanyId optional	string	Company resource ID (-1 for all)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetClients/Individual/-1")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetDriversOfACompany/{strCompanyID}Get all drivers for a company

Parameter	Type	Description
strCompanyID	string	Company resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetDriversOfACompany/700")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetIndependentDrivers/{strType}Get independent drivers by type

Parameter	Type	Description
strType	string	Driver type (CDL, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentDrivers/CDL")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetVehicleRegisteredatALocation/{strRealEstateId}/{strCategory}/{strType}Get vehicles registered at a location

Parameter	Type	Description
strRealEstateId	string	Real estate resource ID
strCategory	string	Vehicle category
strType	string	Vehicle type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehicleRegisteredatALocation/1000/Vehicle/Car")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetVehiclesOfACompany/{strCompanyID}Get all vehicles belonging to a company

Parameter	Type	Description
strCompanyID	string	Company resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetVehiclesOfACompany/700")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetRegisteredVehicles/{strOwnerId}/{strCategory}/{strType}Get vehicles registered to an owner filtered by category and type

Parameter	Type	Description
strOwnerId	string	Owner user ID
strCategory	string	Category
strType	string	Type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRegisteredVehicles/500/Vehicle/Car")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetIndependentVehicles/{strType}Get vehicles not associated with a company

Parameter	Type	Description
strType	string	Vehicle type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIndependentVehicles/Car")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllLeasedResourceIds/{userId}Get IDs of all resources leased by a user

Parameter	Type	Description
userId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResourceIds/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllLeasedResources/{userID}Get all real estate resources leased by a user

Parameter	Type	Description
userID	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllLeasedResources/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetLeasedResources/{userID}/{category}Get leased resources filtered by category

Parameter	Type	Description
userID	string	User ID
category	string	Resource category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLeasedResources/500/RealEstate")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllOwnedResources/{userID}Get all resources owned by a user

Parameter	Type	Description
userID	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOwnedResources/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnedResources/{userID}/{category}Get owned resources filtered by category

Parameter	Type	Description
userID	string	User ID
category	string	Resource category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwnedResources/500/RealEstate")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllRealEstate/{subMerchantId}Get all real estate resources for a merchant

Parameter	Type	Description
subMerchantId	string	Sub-merchant resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstate/800")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllRealEstateOfCategory/{subMerchantId}/{strCategory}Get real estate of a specific category for a merchant

Parameter	Type	Description
subMerchantId	string	Sub-merchant resource ID
strCategory	string	Real estate category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategory/800/Residential")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllRealEstateOfCategoryAndType/{subMerchantId}/{strCategory}/{strType}Get real estate of a specific category and type

Parameter	Type	Description
subMerchantId	string	Sub-merchant resource ID
strCategory	string	Category
strType	string	Type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllRealEstateOfCategoryAndType/800/Residential/Apartment")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Register Resource

GETRegister/{strOwnerId}/{Category}/{Type}/{Quantity}/{Price}/{Currency}/{Capacity}/{Region}/{City}/{State}/{Country}Register a resource with basic fields

Parameter	Type	Description
strOwnerId	string	Owner user ID
Category	string	Resource category
Type	string	Resource type
Quantity	string	Number of units
Price	string	Price per unit
Currency	string	Currency code
Capacity	string	Capacity
Region	string	Region
City	string	City
State	string	State
Country	string	Country

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Register/500/Parking/Outdoor/10/15.00/USD/10/US-NW/Seattle/WA/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterDetailed/{strOwnerId}/{tenancyID}/{Category}/{SubCategory}/{Type}/{SubType}/{Description}/{Quantity}/{Price}/{Currency}/{Capacity}/{Region}/{City}/{State}/{Country}Register a resource with full category and description details

Parameter	Type	Description
strOwnerId	string	Owner user ID
tenancyID	string	Tenancy/merchant ID
Category	string	Category
SubCategory	string	Sub-category
Type	string	Type
SubType	string	Sub-type
Description	string	Description
Quantity	string	Quantity
Price	string	Price
Currency	string	Currency
Capacity	string	Capacity
Region	string	Region
City	string	City
State	string	State
Country	string	Country

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterDetailed/500/800/Parking/Indoor/Standard/Compact/Indoor parking spot near elevator/1/25.00/USD/1/US-NW/Seattle/WA/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterInKnownLocation/{strOwnerId}/{Category}/{Type}/{Quantity}/{Price}/{Currency}/{Capacity}/{LocationId}Register a resource at an existing location

Parameter	Type	Description
strOwnerId	string	Owner user ID
Category	string	Category
Type	string	Type
Quantity	string	Quantity
Price	string	Price
Currency	string	Currency
Capacity	string	Capacity
LocationId	string	Existing location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocation/500/Parking/Outdoor/5/10.00/USD/5/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterInKnownLocationDetailed/{strOwnerId}/{tenancyID}/{Category}/{SubCategory}/{Type}/{SubType}/{Description}/{Quantity}/{Price}/{Currency}/{Capacity}/{LocationId}Register a resource at an existing location with full details

Parameter	Type	Description
strOwnerId	string	Owner user ID
tenancyID	string	Tenancy ID
Category	string	Category
SubCategory	string	Sub-category
Type	string	Type
SubType	string	Sub-type
Description	string	Description
Quantity	string	Quantity
Price	string	Price
Currency	string	Currency
Capacity	string	Capacity
LocationId	string	Existing location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterInKnownLocationDetailed/500/800/Parking/Indoor/Standard/Regular/Parking spot B12/1/20.00/USD/1/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterEVChargingStation/{strOwnerId}/{DeviceType}/{Region}/{Latitude}/{Longitude}/{Price}/{Capacity}/{Location}Register an EV charging station resource

Parameter	Type	Description
strOwnerId	string	Owner user ID
DeviceType	string	Device/charger type (Level2, DC Fast, etc.)
Region	string	Region
Latitude	string	Latitude
Longitude	string	Longitude
Price	string	Price per kWh or session
Capacity	string	Number of charging ports
Location	string	Location name or ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterEVChargingStation/500/Level2/US-NW/47.6062/-122.3321/0.35/4/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Resource CRUD

Use SaveResourceToDatabase instead of SetResource when creating resources that have sub-objects (category, valuation, location). SetResource does not handle sub-objects.

POSTSaveResourceToDatabasePreferred method to create a resource. Handles category, valuation, and location sub-objects automatically.

Parameter	Type	Description
(body)	Resource	Full Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"FriendlyName":"Parking Spot A1","Category":"Parking","Type":"Indoor","OwnerId":500,"LocationId":400,"Price":20.00,"Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"FriendlyName":"Parking Spot A1","Category":"Parking","Type":"Indoor","OwnerId":500,"LocationId":400,"Price":20.00,"Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"FriendlyName":"Parking Spot A1","Category":"Parking","Type":"Indoor","OwnerId":500,"LocationId":400,"Price":20.00,"Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"FriendlyName":"Parking Spot A1","Category":"Parking","Type":"Indoor","OwnerId":500,"LocationId":400,"Price":20.00,"Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"FriendlyName\":\"Parking Spot A1\",\"Category\":\"Parking\",\"Type\":\"Indoor\",\"OwnerId\":500,\"LocationId\":400,\"Price\":20.00,\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"FriendlyName":"Parking Spot A1","Category":"Parking","Type":"Indoor","OwnerId":500,"LocationId":400,"Price":20.00,"Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveResourceToDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"FriendlyName":"Parking Spot A1","Category":"Parking","Type":"Indoor","OwnerId":500,"LocationId":400,"Price":20.00,"Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetResourceCreate a resource (does NOT handle sub-objects — prefer SaveResourceToDatabase)

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"FriendlyName":"Resource Name","Category":"Parking","Type":"Indoor","OwnerId":500}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"FriendlyName":"Resource Name","Category":"Parking","Type":"Indoor","OwnerId":500}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"FriendlyName":"Resource Name","Category":"Parking","Type":"Indoor","OwnerId":500};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"FriendlyName":"Resource Name","Category":"Parking","Type":"Indoor","OwnerId":500};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"FriendlyName\":\"Resource Name\",\"Category\":\"Parking\",\"Type\":\"Indoor\",\"OwnerId\":500}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"FriendlyName":"Resource Name","Category":"Parking","Type":"Indoor","OwnerId":500};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"FriendlyName":"Resource Name","Category":"Parking","Type":"Indoor","OwnerId":500}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceById/{resourceId}/{useCache}Get a full Resource object by ID; useCache=true uses MemoryCache

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceById/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetIResourceById/{resourceId}Get an IntangibleResource by ID

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIResourceById/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNewResource/{ResourceCategory}/{strType}/{quantity}/{configurtion}/{parentid}Get a new unpersisted Resource object pre-configured for a category/type

Parameter	Type	Description
ResourceCategory	string	Resource category
strType	string	Resource type
quantity	string	Quantity
configurtion	string	Configuration string
parentid optional	string	Parent resource ID (-1 if none)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewResource/Parking/Indoor/1/default/-1")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceTypeFromResourceId/{resourceId}Get the type string for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceTypeFromResourceId/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllChildResources/{parentId}Get all child resources of a parent resource

Parameter	Type	Description
parentId	string	Parent resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResources/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllChildResourceIds/{parentId}Get IDs of all child resources

Parameter	Type	Description
parentId	string	Parent resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllChildResourceIds/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetChildResourcesByResourceProperty/{ParentResourceID}/{ResourcePropertyName}/{ResourcePropertyValue}Get child resources filtered by a property value

Parameter	Type	Description
ParentResourceID	string	Parent resource ID
ResourcePropertyName	string	Property name to filter on
ResourcePropertyValue	string	Property value to match

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildResourcesByResourceProperty/1000/Color/Blue")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateResourceInDatabaseUpdate a resource in the database

Parameter	Type	Description
(body)	Resource	Updated Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"FriendlyName":"Updated Name","Price":25.00}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"FriendlyName":"Updated Name","Price":25.00}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"FriendlyName":"Updated Name","Price":25.00};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"FriendlyName":"Updated Name","Price":25.00};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"FriendlyName\":\"Updated Name\",\"Price\":25.00}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"FriendlyName":"Updated Name","Price":25.00};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceInDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"FriendlyName":"Updated Name","Price":25.00}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceUpdate a resource (with business logic)

Parameter	Type	Description
(body)	Resource	Updated Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"FriendlyName":"Updated Name"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"FriendlyName":"Updated Name"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"FriendlyName":"Updated Name"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"FriendlyName":"Updated Name"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"FriendlyName\":\"Updated Name\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"FriendlyName":"Updated Name"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"FriendlyName":"Updated Name"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceShallowUpdate resource top-level fields only (no sub-objects)

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"FriendlyName":"Updated Name"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"FriendlyName":"Updated Name"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"FriendlyName":"Updated Name"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"FriendlyName":"Updated Name"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"FriendlyName\":\"Updated Name\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"FriendlyName":"Updated Name"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceShallow")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"FriendlyName":"Updated Name"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTInsertResourceHistoryInsert a resource history record

Parameter	Type	Description
(body)	Resource	Resource with history data

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistory")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTInsertResourceHistoriesInsert multiple resource history records

Parameter	Type	Description
(body)	List[ResourceHistory]	List of ResourceHistory objects

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"ResourceID":1000,"PropertyName":"Status","OldValue":"Available","NewValue":"Occupied"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"ResourceID":1000,"PropertyName":"Status","OldValue":"Available","NewValue":"Occupied"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"ResourceID":1000,"PropertyName":"Status","OldValue":"Available","NewValue":"Occupied"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"ResourceID":1000,"PropertyName":"Status","OldValue":"Available","NewValue":"Occupied"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"ResourceID\":1000,\"PropertyName\":\"Status\",\"OldValue\":\"Available\",\"NewValue\":\"Occupied\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"ResourceID":1000,"PropertyName":"Status","OldValue":"Available","NewValue":"Occupied"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceHistories")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"ResourceID":1000,"PropertyName":"Status","OldValue":"Available","NewValue":"Occupied"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceHistory/{resourceId}Get history records for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistory/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceHistoryForAGivenProperty/{resourceId}/{strPropName}Get history for a specific property of a resource

Parameter	Type	Description
resourceId	string	Resource ID
strPropName	string	Property name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenProperty/1000/Status")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceHistoryForAGivenPropertyAndTimeDuration/{resourceId}/{strPropName}/{startTime}/{endTime}Get property history within a time range

Parameter	Type	Description
resourceId	string	Resource ID
strPropName	string	Property name
startTime	string	Start time
endTime	string	End time

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenPropertyAndTimeDuration/1000/Status/2024-01-01/2024-12-31")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceHistoryForAGivenTime/{resourceId}/{startTime}/{endTime}Get all history for a resource within a time range

Parameter	Type	Description
resourceId	string	Resource ID
startTime	string	Start time
endTime	string	End time

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceHistoryForAGivenTime/1000/2024-01-01/2024-12-31")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateResourceLocationUpdate the location of a resource

Parameter	Type	Description
(body)	Resource	Resource with updated location

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"LocationId":401}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"LocationId":401}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"LocationId":401};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"LocationId":401};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"LocationId\":401}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"LocationId":401};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceLocation")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"LocationId":401}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateValuationIDForResource/{rvID}/{rID}Link a valuation record to a resource

Parameter	Type	Description
rvID	string	Resource valuation ID
rID	string	Resource ID

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateValuationIDForResource/500/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteResource/{id}Delete a resource by ID

Parameter	Type	Description
id	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResource/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETActivateDeactivateResource/{id}/{Action}Activate or deactivate a resource

Parameter	Type	Description
id	string	Resource ID
Action	string	Action: Activate or Deactivate

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateDeactivateResource/1000/Activate")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddUpdateOwner/{strResourceID}/{strOwnerId}Set or update the owner of a resource

Parameter	Type	Description
strResourceID	string	Resource ID
strOwnerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateOwner/1000/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddUpdateLeasee/{strResourceID}/{strLeaseeId}Set or update the leasee (tenant) of a resource

Parameter	Type	Description
strResourceID	string	Resource ID
strLeaseeId	string	Leasee user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddUpdateLeasee/1000/501")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddOccupant/{strResourceID}/{OccupantId}/{OccupantType}Add an occupant to a resource

Parameter	Type	Description
strResourceID	string	Resource ID
OccupantId	string	Occupant user ID
OccupantType	string	Occupant type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOccupant/1000/502/Guest")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOccupants/{strResourceID}Get all occupant IDs for a resource

Parameter	Type	Description
strResourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOccupants/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAssignResourceToAUser/{resId}/{userId}Assign a resource to a user

Parameter	Type	Description
resId	string	Resource ID
userId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignResourceToAUser/1000/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETUnAssignUserFromAResource/{resId}/{userId}Remove user assignment from a resource

Parameter	Type	Description
resId	string	Resource ID
userId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAResource/1000/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetMerchantRegistrationIdWithAProcessor/{resourceId}/{MethodOfPayment}Get the processor registration ID for a merchant and payment method

Parameter	Type	Description
resourceId	string	Merchant resource ID
MethodOfPayment	string	Payment method (Stripe, PayFac, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetMerchantRegistrationIdWithAProcessor/800/Stripe")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETDecrypt/{stringToDecrypt}/{DecryptMethod}/{premeble}Decrypt an encrypted string

Parameter	Type	Description
stringToDecrypt	string	Encrypted string
DecryptMethod	string	Decryption method
premeble	string	Preamble/key hint

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Decrypt/abc123encrypted/AES/FINERA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetConfiguration/{DeviceId}/{configName}Get a device configuration value

Parameter	Type	Description
DeviceId	string	Device resource ID
configName	string	Configuration name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetConfiguration/900/MaxPower")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETActivateAttachedDevice/{DeviceId}/{AttachedDeviceType}Activate a device attached to a resource

Parameter	Type	Description
DeviceId	string	Device resource ID
AttachedDeviceType	string	Attached device type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ActivateAttachedDevice/900/Sensor")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETSetAttachedDevice/{DeviceId}/{AttachedDeviceType}Register an attached device

Parameter	Type	Description
DeviceId	string	Device resource ID
AttachedDeviceType	string	Attached device type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAttachedDevice/900/Sensor")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateResourceTypeUpdate the type of a resource

Parameter	Type	Description
(body)	Resource	Resource with updated type

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"Type":"Deluxe"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"Type":"Deluxe"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"Type":"Deluxe"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"Type":"Deluxe"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"Type\":\"Deluxe\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"Type":"Deluxe"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceType")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"Type":"Deluxe"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetTypeOfResourceSet the type record for a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTypeOfResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetResourceTypeSet a ResourceType record

Parameter	Type	Description
(body)	ResourceType	ResourceType object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CategoryName":"Parking","TypeName":"Indoor"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CategoryName":"Parking","TypeName":"Indoor"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CategoryName":"Parking","TypeName":"Indoor"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CategoryName":"Parking","TypeName":"Indoor"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CategoryName\":\"Parking\",\"TypeName\":\"Indoor\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CategoryName":"Parking","TypeName":"Indoor"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceType")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CategoryName":"Parking","TypeName":"Indoor"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetCategoryForResourceSet the category for a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"Category":"Parking"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"Category":"Parking"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"Category":"Parking"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"Category":"Parking"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"Category\":\"Parking\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"Category":"Parking"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategoryForResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"Category":"Parking"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetCategory/{ResourceCategoryName}/{ResourceCategoryType}Create a resource category

Parameter	Type	Description
ResourceCategoryName	string	Category name
ResourceCategoryType	string	Category type

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCategory/Parking/Physical")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTInsertCategoryInsert a category object

Parameter	Type	Description
(body)	Category	Category object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CategoryName":"Parking","CategoryType":"Physical"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CategoryName":"Parking","CategoryType":"Physical"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CategoryName":"Parking","CategoryType":"Physical"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CategoryName":"Parking","CategoryType":"Physical"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CategoryName\":\"Parking\",\"CategoryType\":\"Physical\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CategoryName":"Parking","CategoryType":"Physical"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertCategory")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CategoryName":"Parking","CategoryType":"Physical"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceType/{typeId}Get a ResourceType by ID

Parameter	Type	Description
typeId	string	ResourceType ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceType/50")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetCategoryById/{catID}Get a Category by ID

Parameter	Type	Description
catID	string	Category ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCategoryById/10")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllTypesInACategory/{category}Get all resource types in a category

Parameter	Type	Description
category	string	Category name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllTypesInACategory/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllResourceTypesGet all resource types

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceTypes")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllCategoriesGet all categories

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllCategories")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllBusinessCategoriesGet all business categories

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllBusinessCategories")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllResourceCategoriesGet all resource categories

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllResourceCategories")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllServiceCategoriesGet all service categories

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceCategories")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Resource Properties

GETSetResourceProperty/{strPropertyName}/{strPropertyValue}/{strResourceID}Set a simple key/value property on a resource

Parameter	Type	Description
strPropertyName	string	Property name
strPropertyValue	string	Property value
strResourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperty/Color/Blue/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetResourcePropertyDetailed/{strPropertyName}/{strPropertyValue}/{strResourceID}/{bIsQuantitative}/{bIsAggregate}/{strAllowedValues}/{fMin}/{fMax}/{fStep}/{strCurrentValue}Set a resource property with quantitative metadata

Parameter	Type	Description
strPropertyName	string	Property name
strPropertyValue	string	Property value
strResourceID	string	Resource ID
bIsQuantitative	string	Is quantitative (true/false)
bIsAggregate	string	Is aggregate (true/false)
strAllowedValues	string	Comma-separated allowed values
fMin	string	Minimum value
fMax	string	Maximum value
fStep	string	Step size
strCurrentValue	string	Current value

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyDetailed/Temperature/22.5/1000/true/false//0/100/0.5/22.5")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetResourcePropertyComplexSet a complex resource property

Parameter	Type	Description
(body)	ResourceProperty	ResourceProperty object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"PropertyName":"Status","PropertyValue":"Available","IsQuantitative":false}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"PropertyName":"Status","PropertyValue":"Available","IsQuantitative":false}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"PropertyName":"Status","PropertyValue":"Available","IsQuantitative":false};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"PropertyName":"Status","PropertyValue":"Available","IsQuantitative":false};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"PropertyName\":\"Status\",\"PropertyValue\":\"Available\",\"IsQuantitative\":false}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"PropertyName":"Status","PropertyValue":"Available","IsQuantitative":false};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourcePropertyComplex")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"PropertyName":"Status","PropertyValue":"Available","IsQuantitative":false}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetResourcePropertiesSet all resource properties from Resource object

Parameter	Type	Description
(body)	Resource	Resource with properties array

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"Properties":[{"Name":"Color","Value":"Blue"}]}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"Properties":[{"Name":"Color","Value":"Blue"}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"Properties":[{"Name":"Color","Value":"Blue"}]};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"Properties":[{"Name":"Color","Value":"Blue"}]};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"Properties\":[{\"Name\":\"Color\",\"Value\":\"Blue\"}]}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"Properties":[{"Name":"Color","Value":"Blue"}]};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"Properties":[{"Name":"Color","Value":"Blue"}]}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETUpdateResourcePropertyByName/{strPropertyName}/{strPropertyValue}/{strResourceID}Update a resource property by name

Parameter	Type	Description
strPropertyName	string	Property name
strPropertyValue	string	New value
strResourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyByName/Color/Red/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateResourceProperty/{strPropertyId}/{strPropertyName}/{strPropertyValue}/{strResourceID}Update a resource property by ID

Parameter	Type	Description
strPropertyId	string	Property ID
strPropertyName	string	Property name
strPropertyValue	string	New value
strResourceID	string	Resource ID

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperty/50/Color/Red/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourcePropertyDetailed/{strPropertyId}/{strPropertyName}/{strPropertyValue}/{strResourceID}/{bIsQuantitative}/{bIsAggregate}/{strAllowedValues}/{fMin}/{fMax}/{fStep}/{strCurrentValue}Update a resource property with quantitative metadata

Parameter	Type	Description
strPropertyId	string	Property ID
strPropertyName	string	Property name
strPropertyValue	string	Value
strResourceID	string	Resource ID
bIsQuantitative	string	Is quantitative
bIsAggregate	string	Is aggregate
strAllowedValues	string	Allowed values
fMin	string	Min
fMax	string	Max
fStep	string	Step
strCurrentValue	string	Current value

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyDetailed/50/Temperature/23.0/1000/true/false//0/100/0.5/23.0")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourcePropertyComplex/{rID}Update a complex resource property

Parameter	Type	Description
rID	string	Resource ID
(body)	ResourceProperty	ResourceProperty object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"PropertyID":50,"PropertyName":"Status","PropertyValue":"Occupied"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"PropertyID":50,"PropertyName":"Status","PropertyValue":"Occupied"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"PropertyID":50,"PropertyName":"Status","PropertyValue":"Occupied"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"PropertyID":50,"PropertyName":"Status","PropertyValue":"Occupied"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"PropertyID\":50,\"PropertyName\":\"Status\",\"PropertyValue\":\"Occupied\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"PropertyID":50,"PropertyName":"Status","PropertyValue":"Occupied"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourcePropertyComplex/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"PropertyID":50,"PropertyName":"Status","PropertyValue":"Occupied"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourcePropertiesUpdate all resource properties from Resource object

Parameter	Type	Description
(body)	Resource	Resource with updated properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"Properties":[{"PropertyID":50,"Name":"Color","Value":"Green"}]}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"Properties":[{"PropertyID":50,"Name":"Color","Value":"Green"}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"Properties":[{"PropertyID":50,"Name":"Color","Value":"Green"}]};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"Properties":[{"PropertyID":50,"Name":"Color","Value":"Green"}]};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"Properties\":[{\"PropertyID\":50,\"Name\":\"Color\",\"Value\":\"Green\"}]}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"Properties":[{"PropertyID":50,"Name":"Color","Value":"Green"}]};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"Properties":[{"PropertyID":50,"Name":"Color","Value":"Green"}]}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteResourceProperty/{id}Delete a resource property by ID

Parameter	Type	Description
id	string	Property ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteResourceProperty/50")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTGetResourcePropertiesGet all properties for a resource (Resource in body)

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourcePropertiesWithNoBusinessLogic/{strResourceId}Get resource properties without applying business rules

Parameter	Type	Description
strResourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertiesWithNoBusinessLogic/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcePropertyByName/{strPropertyName}/{strResourceID}Get the value of a specific property by name

Parameter	Type	Description
strPropertyName	string	Property name
strResourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByName/Color/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcePropertyByPropertyId/{propertyId}Get a full ResourceProperty object by ID

Parameter	Type	Description
propertyId	string	Property ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyByPropertyId/50")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETSearchAllResourceProperties/{strSearch}/{strResourceID}Search all properties of a resource returning matching key/value pairs

Parameter	Type	Description
strSearch	string	Search term
strResourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllResourceProperties/color/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcePropertyNamesForAGivenResourceCategory/{strCategoryName}Get all property names defined for a resource category

Parameter	Type	Description
strCategoryName	string	Category name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcePropertyNamesForAGivenResourceCategory/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUniquePropertyValuesOfChildren/{parentId}/{propertyName}Get distinct values of a property across child resources

Parameter	Type	Description
parentId	string	Parent resource ID
propertyName	string	Property name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUniquePropertyValuesOfChildren/1000/Color")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetChildrenIdsForAGivenProperty/{parentId}/{propertyName}/{propertyValue}Get IDs of child resources that have a specific property value

Parameter	Type	Description
parentId	string	Parent resource ID
propertyName	string	Property name
propertyValue	string	Property value to match

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetChildrenIdsForAGivenProperty/1000/Color/Blue")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesForAGivenPropertyAndCategoryInACity/{propertyName}/{propertyValue}/{category}/{city}/{state}Get resource IDs matching a property in a city

Parameter	Type	Description
propertyName	string	Property name
propertyValue	string	Property value
category	string	Resource category
city	string	City
state	string	State

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategoryInACity/ParkingType/Indoor/Parking/Seattle/WA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesForAGivenPropertyAndCategory/{propertyName}/{propertyValue}/{category}Get resource IDs matching a property and category

Parameter	Type	Description
propertyName	string	Property name
propertyValue	string	Property value
category	string	Resource category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAGivenPropertyAndCategory/ParkingType/Indoor/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesForAMatchingPropertyName/{propertyName}Get IDs of all resources that have a given property name

Parameter	Type	Description
propertyName	string	Property name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesForAMatchingPropertyName/ParkingType")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesWithQRCodesGet IDs of all resources that have QR codes

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesWithQRCodes")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAvailableResourcePropertyValuesForAGivenPropertyName/{strPropertyName}Get all known values for a resource property name

Parameter	Type	Description
strPropertyName	string	Property name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyName/ParkingType")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/{strPropertyName}/{strResourceCategory}Get known values for a property name within a category

Parameter	Type	Description
strPropertyName	string	Property name
strResourceCategory	string	Resource category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableResourcePropertyValuesForAGivenPropertyNameAndResourceCategory/ParkingType/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETMakeFavourite/{strResourceId}/{strUserId}Mark a resource as a favourite for a user

Parameter	Type	Description
strResourceId	string	Resource ID
strUserId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeFavourite/1000/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETisResourceFavourite/{strResourceId}/{strUserId}Check if a resource is marked as favourite by a user

Parameter	Type	Description
strResourceId	string	Resource ID
strUserId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/isResourceFavourite/1000/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETReportResourceStatus/{strPropertyId}/{strCurrentValue}Report a new status value for a resource property

Parameter	Type	Description
strPropertyId	string	Property ID
strCurrentValue	string	Current value to report

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReportResourceStatus/50/22.5")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETReport/{strResourceId}/{strPropertyName}/{strCurrentValue}Report a property value by name for a resource

Parameter	Type	Description
strResourceId	string	Resource ID
strPropertyName	string	Property name
strCurrentValue	string	Current value

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Report/1000/Temperature/22.5")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Search & Discovery

GETSearchForResource/{searchstring}Full-text search for resources; returns ResourceCollections

Parameter	Type	Description
searchstring	string	Search term

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchForResource/parking Seattle")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceCollections/{strSearch}Find resource collections by search string

Parameter	Type	Description
strSearch	string	Search term

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollections/apartment")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceCollectionsEfficient/{strSearch}/{strCategoryName}Efficiently find collection IDs by search term and category

Parameter	Type	Description
strSearch	string	Search term
strCategoryName	string	Category name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsEfficient/apartment/RealEstate")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceEfficientWithGivenCategoryAndType/{strSearch}/{strCategoryName}/{strType}Find resource IDs by search term, category, and type

Parameter	Type	Description
strSearch	string	Search term
strCategoryName	string	Category
strType	string	Type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientWithGivenCategoryAndType/studio/RealEstate/Apartment")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceEfficient/{strSearch}/{strCategoryName}Find resource IDs by search term and category

Parameter	Type	Description
strSearch	string	Search term
strCategoryName	string	Category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficient/parking/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceEfficientAt/{strSearch}/{strCategoryName}/{searchlocation}Find resources by search term at a location

Parameter	Type	Description
strSearch	string	Search term
strCategoryName	string	Category
searchlocation optional	string	Location filter (any, city, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceEfficientAt/parking/Parking/Seattle")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTFindResourceCollectionsByProperty/{strSearch}Find resource collections by search term and a property filter

Parameter	Type	Description
strSearch	string	Search term
(body)	GenericProperty	Property filter object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Name":"ParkingType","Value":"Indoor"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Name":"ParkingType","Value":"Indoor"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Name":"ParkingType","Value":"Indoor"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Name":"ParkingType","Value":"Indoor"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Name\":\"ParkingType\",\"Value\":\"Indoor\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Name":"ParkingType","Value":"Indoor"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByProperty/parking")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Name":"ParkingType","Value":"Indoor"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETFindResourceCollectionsByPropertySimple/{strSearch}/{strPropertyName}/{strPropertyValue}Find collections by search term and property name/value

Parameter	Type	Description
strSearch	string	Search term
strPropertyName	string	Property name
strPropertyValue	string	Property value

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceCollectionsByPropertySimple/parking/ParkingType/Indoor")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesByCategoryName/{strCategoryName}Get resources by category name. NOTE: does NOT load child resources.

Parameter	Type	Description
strCategoryName	string	Category name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesByCategoryName/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesShallowNoChildrenByCategoryName/{strCategoryName}Get shallow resource list (no children) by category

Parameter	Type	Description
strCategoryName	string	Category name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesShallowNoChildrenByCategoryName/Parking")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceIdsOfAGivenCategoryInAGivenCity/{category}/{city}/{state}Get resource IDs of a category in a city/state

Parameter	Type	Description
category	string	Category name
city	string	City
state	string	State

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCity/Parking/Seattle/WA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/{CategoryName}/{Type}/{City}/{State}/{Country}/{MinPrice}/{MaxPrice}Get resource IDs filtered by category, type, city, and price range

Parameter	Type	Description
CategoryName	string	Category name
Type	string	Type
City	string	City
State	string	State
Country	string	Country
MinPrice	string	Minimum price
MaxPrice	string	Maximum price

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRange/Parking/Indoor/Seattle/WA/US/0/50")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/{CategoryName}/{Type}/{City}/{State}/{Country}/{MinPrice}/{MaxPrice}/{SupportedServices}Get resources filtered by category, price range, and supported service types

Parameter	Type	Description
CategoryName	string	Category
Type	string	Type
City	string	City
State	string	State
Country	string	Country
MinPrice	string	Min price
MaxPrice	string	Max price
SupportedServices	string	Comma-separated service types

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceIdsOfAGivenCategoryInAGivenCityAndPriceRangeSupportingSpecificService/Parking/Indoor/Seattle/WA/US/0/50/EV,Car")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetTopNResourceCollections/{topN}Get top N resource collections by date

Parameter	Type	Description
topN	string	Number to retrieve

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollections/10")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetTopNResourceCollectionsWithImages/{topN}Get top N resource collections that have images

Parameter	Type	Description
topN	string	Number to retrieve

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNResourceCollectionsWithImages/10")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOwnersGet all users with Owner permission

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOwners")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBorrowersGet all users with Borrower permission

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBorrowers")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetLendersGet all users with Lender permission

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLenders")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Scheduling & Availability

POSTSetScheduleForResource/{rcID}Set a schedule for a resource collection

Parameter	Type	Description
rcID	string	Resource collection ID
(body)	Schedule	Schedule object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00","IsRecurring":true}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00","IsRecurring":true}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00","IsRecurring":true};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00","IsRecurring":true};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"StartTime\":\"2024-06-01T09:00:00\",\"EndTime\":\"2024-06-01T17:00:00\",\"IsRecurring\":true}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00","IsRecurring":true};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResource/200")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00","IsRecurring":true}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetScheduleForResourceWithResourceID/{resourceID}Set a schedule for a resource by resource ID

Parameter	Type	Description
resourceID	string	Resource ID
(body)	Schedule	Schedule object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"StartTime\":\"2024-06-01T09:00:00\",\"EndTime\":\"2024-06-01T17:00:00\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleForResourceWithResourceID/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-01T17:00:00"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetScheduleProperties/{scheduleId}Set properties for a schedule

Parameter	Type	Description
scheduleId	string	Schedule ID
(body)	List[ScheduleProperty]	List of schedule properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"PropertyName":"Timezone","PropertyValue":"America/Los_Angeles"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"PropertyName":"Timezone","PropertyValue":"America/Los_Angeles"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"PropertyName":"Timezone","PropertyValue":"America/Los_Angeles"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"PropertyName":"Timezone","PropertyValue":"America/Los_Angeles"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"PropertyName\":\"Timezone\",\"PropertyValue\":\"America/Los_Angeles\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"PropertyName":"Timezone","PropertyValue":"America/Los_Angeles"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetScheduleProperties/600")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"PropertyName":"Timezone","PropertyValue":"America/Los_Angeles"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetScheduleProperties/{scheduleId}Get properties for a schedule

Parameter	Type	Description
scheduleId	string	Schedule ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleProperties/600")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateScheduleForResource/{rcID}Update schedule for a resource collection

Parameter	Type	Description
rcID	string	Resource collection ID
(body)	Schedule	Updated Schedule

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ScheduleID":600,"StartTime":"2024-07-01T09:00:00"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ScheduleID":600,"StartTime":"2024-07-01T09:00:00"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ScheduleID":600,"StartTime":"2024-07-01T09:00:00"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ScheduleID":600,"StartTime":"2024-07-01T09:00:00"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ScheduleID\":600,\"StartTime\":\"2024-07-01T09:00:00\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ScheduleID":600,"StartTime":"2024-07-01T09:00:00"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleForResource/200")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ScheduleID":600,"StartTime":"2024-07-01T09:00:00"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateSchedulePropertiesUpdate schedule properties

Parameter	Type	Description
(body)	List[ScheduleProperty]	List of updated schedule properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"America/New_York"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"America/New_York"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"America/New_York"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"America/New_York"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"PropertyID\":1,\"PropertyName\":\"Timezone\",\"PropertyValue\":\"America/New_York\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"America/New_York"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"America/New_York"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateSchedulePropertyUpdate a single schedule property

Parameter	Type	Description
(body)	ScheduleProperty	Schedule property to update

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"UTC"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"UTC"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"UTC"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"UTC"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"PropertyID\":1,\"PropertyName\":\"Timezone\",\"PropertyValue\":\"UTC\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"UTC"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateScheduleProperty")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"PropertyID":1,"PropertyName":"Timezone","PropertyValue":"UTC"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateScheduleUpdate a schedule object

Parameter	Type	Description
(body)	Schedule	Updated Schedule

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ScheduleID":600,"StartTime":"2024-06-15T10:00:00"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ScheduleID":600,"StartTime":"2024-06-15T10:00:00"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ScheduleID":600,"StartTime":"2024-06-15T10:00:00"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ScheduleID":600,"StartTime":"2024-06-15T10:00:00"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ScheduleID\":600,\"StartTime\":\"2024-06-15T10:00:00\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ScheduleID":600,"StartTime":"2024-06-15T10:00:00"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateSchedule")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ScheduleID":600,"StartTime":"2024-06-15T10:00:00"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteSchedule/{serviceId}Delete a schedule by ID

Parameter	Type	Description
serviceId	string	Schedule ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteSchedule/600")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetScheduleByResourceId/{resourceId}Get schedules for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceId/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetScheduleByResourceCollectionId/{rcID}Get schedules for a resource collection

Parameter	Type	Description
rcID	string	Resource collection ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleByResourceCollectionId/200")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetScheduleById/{scheduleId}Get a schedule by ID

Parameter	Type	Description
scheduleId	string	Schedule ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetScheduleById/600")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetResourceSchedule/{resourceId}Set a schedule for a resource

Parameter	Type	Description
resourceId	string	Resource ID
(body)	Schedule	Schedule object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-30T17:00:00"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-30T17:00:00"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-30T17:00:00"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-30T17:00:00"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"StartTime\":\"2024-06-01T09:00:00\",\"EndTime\":\"2024-06-30T17:00:00\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-30T17:00:00"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSchedule/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"StartTime":"2024-06-01T09:00:00","EndTime":"2024-06-30T17:00:00"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETFindResourceAvailabilityInAMonth/{resourceId}/{month}/{Year}/{slot_duration=30}Find available time slots for a resource in a month (returns AppObjects_Schedule)

Parameter	Type	Description
resourceId	string	Resource ID
month	string	Month number (1-12)
Year	string	Year
slot_duration=30 optional	string	Slot duration in minutes (default 30)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityInAMonth/1000/6/2024/30")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceAvailabilityOnAGivenDay/{resourceId}/{day}/{month}/{Year}/{slot_duration=30}Find available time slots for a resource on a specific day

Parameter	Type	Description
resourceId	string	Resource ID
day	string	Day of month
month	string	Month
Year	string	Year
slot_duration=30 optional	string	Slot duration in minutes

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailabilityOnAGivenDay/1000/15/6/2024/30")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETFindResourceAvailability/{resourceId}/{month}/{Year}/{slot_duration=30}Find available schedules for a resource in a month

Parameter	Type	Description
resourceId	string	Resource ID
month	string	Month
Year	string	Year
slot_duration=30 optional	string	Slot duration in minutes

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/FindResourceAvailability/1000/6/2024/30")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppointments/{resourceId}Get all appointments for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointments/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppointmentsRecord/{resourceId}Get appointment records for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppointmentsRecord/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddAppointmentRecord/{strAppointmentID}/{strMedicalCondition}/{strPrescribedMedication}Add a medical record to an appointment

Parameter	Type	Description
strAppointmentID	string	Appointment ID
strMedicalCondition	string	Diagnosed condition
strPrescribedMedication	string	Medication prescribed

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddAppointmentRecord/700/Hypertension/Lisinopril 10mg")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRescheduleAppointment/{strAppointmentId}/{yearStart}/{monthStart}/{dayStart}/{hourStart}/{minuteStart}/{secondStart}/{millisecondStart}/{yearEnd}/{monthEnd}/{dayEnd}/{hourEnd}/{minuteEnd}/{secondEnd}/{millisecondEnd}Reschedule an appointment to a new time

Parameter	Type	Description
strAppointmentId	string	Appointment ID
yearStart	string	Start year
monthStart	string	Start month
dayStart	string	Start day
hourStart	string	Start hour
minuteStart	string	Start minute
secondStart	string	Start second
millisecondStart	string	Start millisecond
yearEnd	string	End year
monthEnd	string	End month
dayEnd	string	End day
hourEnd	string	End hour
minuteEnd	string	End minute
secondEnd	string	End second
millisecondEnd	string	End millisecond

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RescheduleAppointment/700/2024/7/15/10/0/0/0/2024/7/15/11/0/0/0")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETCancelAppointment/{strAppointmentId}Cancel an appointment

Parameter	Type	Description
strAppointmentId	string	Appointment ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelAppointment/700")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETDeleteAppointment/{strAppointmentId}Delete an appointment

Parameter	Type	Description
strAppointmentId	string	Appointment ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAppointment/700")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Services

GETAddNewServiceSimplest/{Name}/{Type}/{strResourceID}/{CustomerId}/{ProviderId}Create a service with minimal fields

Parameter	Type	Description
Name	string	Service name
Type	string	Service type
strResourceID	string	Resource ID the service is for
CustomerId	string	Customer user ID
ProviderId	string	Service provider user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewServiceSimplest/Lawn Mowing/Maintenance/1000/500/501")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddNewService/{Name}/{Type}/{strResourceID}/{strServiceLocationId}/{strPickupLocationId}/{strDropOffLocationId}/{Cost}/{CustomerId}/{ProviderId}/{ScheduleId}Create a service with full location and cost details

Parameter	Type	Description
Name	string	Service name
Type	string	Service type
strResourceID	string	Resource ID
strServiceLocationId	string	Service location ID
strPickupLocationId	string	Pickup location ID
strDropOffLocationId	string	Drop-off location ID
Cost	string	Service cost
CustomerId	string	Customer user ID
ProviderId	string	Provider user ID
ScheduleId	string	Schedule ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewService/Car Wash/Cleaning/1000/400/401/402/50.00/500/501/600")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRequestService/{ServiceRequestName}/{ServiceRequestType}/{strResourceID}/{ServiceLocationId}/{strRequesterID}Request a service for a resource

Parameter	Type	Description
ServiceRequestName	string	Service request name
ServiceRequestType	string	Service request type
strResourceID	string	Resource ID
ServiceLocationId	string	Service location ID
strRequesterID	string	Requestor user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestService/Oil Change/Maintenance/1000/400/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRequestSpecificService/{serviceID}/{strResourceID}/{ServiceLocationId}/{strRequestorID}/{yearStart}/{monthStart}/{dayStart}/{hourStart}/{minuteStart}/{secondStart}/{millisecondStart}/{yearEnd}/{monthEnd}/{dayEnd}/{hourEnd}/{minuteEnd}/{secondEnd}/{millisecondEnd}Request a specific service with a time window

Parameter	Type	Description
serviceID	string	Service template ID
strResourceID	string	Resource ID
ServiceLocationId	string	Location ID
strRequestorID	string	Requestor user ID
yearStart	string	Start year
monthStart	string	Start month
dayStart	string	Start day
hourStart	string	Start hour
minuteStart	string	Start minute
secondStart	string	Start second
millisecondStart	string	Start millisecond
yearEnd	string	End year
monthEnd	string	End month
dayEnd	string	End day
hourEnd	string	End hour
minuteEnd	string	End minute
secondEnd	string	End second
millisecondEnd	string	End millisecond

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RequestSpecificService/300/1000/400/500/2024/6/15/9/0/0/0/2024/6/15/10/0/0/0")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetServiceCreate a service via Service object

Parameter	Type	Description
(body)	Service	Service object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Lawn Mowing","Type":"Maintenance","ResourceID":1000,"CustomerID":500,"ProviderID":501}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Name":"Lawn Mowing","Type":"Maintenance","ResourceID":1000,"CustomerID":500,"ProviderID":501}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Name":"Lawn Mowing","Type":"Maintenance","ResourceID":1000,"CustomerID":500,"ProviderID":501};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Name":"Lawn Mowing","Type":"Maintenance","ResourceID":1000,"CustomerID":500,"ProviderID":501};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Name\":\"Lawn Mowing\",\"Type\":\"Maintenance\",\"ResourceID\":1000,\"CustomerID\":500,\"ProviderID\":501}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Name":"Lawn Mowing","Type":"Maintenance","ResourceID":1000,"CustomerID":500,"ProviderID":501};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetService")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Name":"Lawn Mowing","Type":"Maintenance","ResourceID":1000,"CustomerID":500,"ProviderID":501}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSaveServiceToDatabaseSave a service to the database

Parameter	Type	Description
(body)	Service	Service object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Car Wash","Type":"Cleaning","ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Name":"Car Wash","Type":"Cleaning","ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Name":"Car Wash","Type":"Cleaning","ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Name":"Car Wash","Type":"Cleaning","ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Name\":\"Car Wash\",\"Type\":\"Cleaning\",\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Name":"Car Wash","Type":"Cleaning","ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SaveServiceToDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Name":"Car Wash","Type":"Cleaning","ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

PUTUpdateServiceUpdate a service

Parameter	Type	Description
(body)	Service	Updated Service object

Code Examples

curl -X PUT "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ServiceID":300,"Status":"InProgress"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ServiceID":300,"Status":"InProgress"}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ServiceID":300,"Status":"InProgress"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService",
  {
    method: "PUT",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ServiceID":300,"Status":"InProgress"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PutAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ServiceID\":300,\"Status\":\"InProgress\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .put(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
$payload = {"ServiceID":300,"Status":"InProgress"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateService")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Put.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ServiceID":300,"Status":"InProgress"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateServiceInDatabaseUpdate a service in the database

Parameter	Type	Description
(body)	Service	Updated Service

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ServiceID":300,"Status":"Completed"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ServiceID":300,"Status":"Completed"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ServiceID":300,"Status":"Completed"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ServiceID":300,"Status":"Completed"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ServiceID\":300,\"Status\":\"Completed\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ServiceID":300,"Status":"Completed"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceInDatabase")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ServiceID":300,"Status":"Completed"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateServiceProperties/{sID}Update service properties

Parameter	Type	Description
sID	string	Service ID
(body)	List[ServiceProperties]	List of service properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"PropertyName":"Priority","PropertyValue":"High"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"PropertyName":"Priority","PropertyValue":"High"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"PropertyName":"Priority","PropertyValue":"High"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"PropertyName":"Priority","PropertyValue":"High"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"PropertyName\":\"Priority\",\"PropertyValue\":\"High\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"PropertyName":"Priority","PropertyValue":"High"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperties/300")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"PropertyName":"Priority","PropertyValue":"High"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateServiceProperty/{sID}Update a single service property

Parameter	Type	Description
sID	string	Service ID
(body)	ServiceProperties	Service property

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"PropertyName":"Status","PropertyValue":"Ready"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"PropertyName":"Status","PropertyValue":"Ready"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"PropertyName":"Status","PropertyValue":"Ready"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"PropertyName":"Status","PropertyValue":"Ready"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"PropertyName\":\"Status\",\"PropertyValue\":\"Ready\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"PropertyName":"Status","PropertyValue":"Ready"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateServiceProperty/300")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"PropertyName":"Status","PropertyValue":"Ready"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteServiceProperty/{id}Delete a service property

Parameter	Type	Description
id	string	Service property ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteServiceProperty/25")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetServiceProperties/{sID}Set properties for a service

Parameter	Type	Description
sID	string	Service ID
(body)	List[ServiceProperties]	Service properties list

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"PropertyName":"Category","PropertyValue":"Premium"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"PropertyName":"Category","PropertyValue":"Premium"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"PropertyName":"Category","PropertyValue":"Premium"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"PropertyName":"Category","PropertyValue":"Premium"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"PropertyName\":\"Category\",\"PropertyValue\":\"Premium\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"PropertyName":"Category","PropertyValue":"Premium"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetServiceProperties/300")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"PropertyName":"Category","PropertyValue":"Premium"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetServicePropertyNamesForAGivenServiceCategory/{strCategoryName}Get all property names for a service category

Parameter	Type	Description
strCategoryName	string	Service category name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServicePropertyNamesForAGivenServiceCategory/Cleaning")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAvailableServicePropertyValuesForAGivenPropertyName/{strPropertyName}Get known values for a service property

Parameter	Type	Description
strPropertyName	string	Service property name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAvailableServicePropertyValuesForAGivenPropertyName/Priority")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTGetServicePropertiesGet properties for a service (Service in body)

Parameter	Type	Description
(body)	Service	Service object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ServiceID":300}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ServiceID":300}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ServiceID":300};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ServiceID":300};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ServiceID\":300}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ServiceID":300};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ServiceID":300}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetRequestedServices/{ownerId}Get services requested by an owner

Parameter	Type	Description
ownerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestedServices/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetService/{serviceOwnerId}/{resourceid}Get services for an owner and resource

Parameter	Type	Description
serviceOwnerId	string	Service owner user ID
resourceid	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetService/500/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceById/{serviceId}Get a service by ID

Parameter	Type	Description
serviceId	string	Service ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceById/300")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceForResource/{resourceId}Get all services for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceForResource/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceByOwnerId/{serviceOwnerId}Get services owned by a user

Parameter	Type	Description
serviceOwnerId	string	Service owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByOwnerId/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceByName/{serviceName}Get a service by name

Parameter	Type	Description
serviceName	string	Service name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByName/Lawn Mowing")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceObjectsByProviderId/{serviceProviderId}Get service objects for a provider (returns AppObjects_Service)

Parameter	Type	Description
serviceProviderId	string	Provider user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceObjectsByProviderId/501")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceByProviderId/{serviceProviderId}Get services for a provider

Parameter	Type	Description
serviceProviderId	string	Provider user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceByProviderId/501")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetPendingServices/{serviceRequestorId}Get pending services for a requestor

Parameter	Type	Description
serviceRequestorId	string	Requestor user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPendingServices/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetUnAssignedCustomerServiceRequests/{InfoRequestorID}Get unassigned service requests

Parameter	Type	Description
InfoRequestorID	string	Requestor user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetUnAssignedCustomerServiceRequests/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetExpiredUnServedServices/{serviceRequestorId}Get expired services that were never served

Parameter	Type	Description
serviceRequestorId	string	Requestor user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetExpiredUnServedServices/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllOpenServiceRequestsGet all open service requests

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllOpenServiceRequests")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllPendingServiceRequestsOfType/{ServiceRequestType}Get pending service requests of a specific type

Parameter	Type	Description
ServiceRequestType	string	Service request type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllPendingServiceRequestsOfType/Maintenance")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllServiceProviders/{ServiceProviderType}Get all service providers of a type

Parameter	Type	Description
ServiceProviderType	string	Provider type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServiceProviders/Plumber")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllServicesGet all services

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllServices")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETSearchAllServices/{strSearch}Search all services by keyword

Parameter	Type	Description
strSearch	string	Search term

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchAllServices/cleaning")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETSearchServices/{strSearch}/{minPrice}/{maxPrice}Search services within a price range

Parameter	Type	Description
strSearch	string	Search term
minPrice	string	Minimum price
maxPrice	string	Maximum price

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SearchServices/cleaning/0/200")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesGet all available services

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServices")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesByCategory/{strCategory}Get available services by category

Parameter	Type	Description
strCategory	string	Service category

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCategory/Cleaning")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesByZipCode/{ZipCode}Get available services in a zip code

Parameter	Type	Description
ZipCode	string	Zip/postal code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByZipCode/98101")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesByCountry/{country}Get available services in a country

Parameter	Type	Description
country	string	Country code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCountry/US")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesByCity/{state}/{city}Get available services in a city

Parameter	Type	Description
state	string	State code
city	string	City name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByCity/WA/Seattle")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesByState/{state}Get available services in a state

Parameter	Type	Description
state	string	State code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByState/WA")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAllAvailableServicesByName/{strName}Get available services matching a name

Parameter	Type	Description
strName	string	Service name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAllAvailableServicesByName/Lawn")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTInsertServiceHistoryInsert service history records

Parameter	Type	Description
(body)	List[ServiceHistory]	Service history list

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"ServiceID":300,"PropertyName":"Status","OldValue":"Pending","NewValue":"InProgress"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"ServiceID":300,"PropertyName":"Status","OldValue":"Pending","NewValue":"InProgress"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"ServiceID":300,"PropertyName":"Status","OldValue":"Pending","NewValue":"InProgress"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"ServiceID":300,"PropertyName":"Status","OldValue":"Pending","NewValue":"InProgress"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"ServiceID\":300,\"PropertyName\":\"Status\",\"OldValue\":\"Pending\",\"NewValue\":\"InProgress\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"ServiceID":300,"PropertyName":"Status","OldValue":"Pending","NewValue":"InProgress"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertServiceHistory")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"ServiceID":300,"PropertyName":"Status","OldValue":"Pending","NewValue":"InProgress"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetServiceHistory/{serviceId}Get history for a service

Parameter	Type	Description
serviceId	string	Service ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistory/300")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceHistoryForAGivenProperty/{serviceId}/{strPropName}Get history of a specific property for a service

Parameter	Type	Description
serviceId	string	Service ID
strPropName	string	Property name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenProperty/300/Status")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceHistoryForAGivenPropertyAndTimeDuration/{serviceId}/{strPropName}/{startTime}/{endTime}Get service property history within a time range

Parameter	Type	Description
serviceId	string	Service ID
strPropName	string	Property name
startTime	string	Start time
endTime	string	End time

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenPropertyAndTimeDuration/300/Status/2024-01-01/2024-12-31")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetServiceHistoryForAGivenTime/{serviceId}/{startTime}/{endTime}Get all service history within a time range

Parameter	Type	Description
serviceId	string	Service ID
startTime	string	Start time
endTime	string	End time

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetServiceHistoryForAGivenTime/300/2024-01-01/2024-12-31")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetBidsOnServiceSubmit a bid on a service

Parameter	Type	Description
(body)	BidOnService	Bid object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ServiceID":300,"BidderID":500,"Amount":75.00,"Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ServiceID":300,"BidderID":500,"Amount":75.00,"Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ServiceID":300,"BidderID":500,"Amount":75.00,"Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ServiceID":300,"BidderID":500,"Amount":75.00,"Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ServiceID\":300,\"BidderID\":500,\"Amount\":75.00,\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ServiceID":300,"BidderID":500,"Amount":75.00,"Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetBidsOnService")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ServiceID":300,"BidderID":500,"Amount":75.00,"Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateBidOnServiceUpdate a bid on a service

Parameter	Type	Description
(body)	BidOnService	Updated bid object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"BidID":100,"Amount":80.00}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"BidID":100,"Amount":80.00}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"BidID":100,"Amount":80.00};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"BidID":100,"Amount":80.00};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"BidID\":100,\"Amount\":80.00}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"BidID":100,"Amount":80.00};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateBidOnService")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"BidID":100,"Amount":80.00}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetBidsOnService/{serviceId}Get all bids on a service

Parameter	Type	Description
serviceId	string	Service ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidsOnService/300")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBidById/{bidID}Get a specific bid by ID

Parameter	Type	Description
bidID	string	Bid ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBidById/100")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetAquireResourceCreate an acquire resource request

Parameter	Type	Description
(body)	AquireResource	AquireResource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"CustomerID":500,"AcquireType":"Purchase"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"CustomerID":500,"AcquireType":"Purchase"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"CustomerID":500,"AcquireType":"Purchase"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"CustomerID":500,"AcquireType":"Purchase"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"CustomerID\":500,\"AcquireType\":\"Purchase\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"CustomerID":500,"AcquireType":"Purchase"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetAquireResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"CustomerID":500,"AcquireType":"Purchase"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateAquireResourceUpdate an acquire resource record

Parameter	Type	Description
(body)	AquireResource	Updated AquireResource

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"AcquireID":50,"Status":"Approved"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"AcquireID":50,"Status":"Approved"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"AcquireID":50,"Status":"Approved"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"AcquireID":50,"Status":"Approved"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"AcquireID\":50,\"Status\":\"Approved\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"AcquireID":50,"Status":"Approved"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateAquireResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"AcquireID":50,"Status":"Approved"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetAquireResouce/{resourceId}Get acquire resource records for a resource

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAquireResouce/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETDeleteAquireResource/{customerID}/{resourceId}Delete an acquire resource record

Parameter	Type	Description
customerID	string	Customer ID
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteAquireResource/500/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetRequestAvailableServiceCreate a request for available service

Parameter	Type	Description
(body)	RequestAvailableService	RequestAvailableService object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ServiceID":300,"RequesterID":500,"RequestedTime":"2024-06-15T10:00:00"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ServiceID":300,"RequesterID":500,"RequestedTime":"2024-06-15T10:00:00"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ServiceID":300,"RequesterID":500,"RequestedTime":"2024-06-15T10:00:00"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ServiceID":300,"RequesterID":500,"RequestedTime":"2024-06-15T10:00:00"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ServiceID\":300,\"RequesterID\":500,\"RequestedTime\":\"2024-06-15T10:00:00\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ServiceID":300,"RequesterID":500,"RequestedTime":"2024-06-15T10:00:00"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetRequestAvailableService")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ServiceID":300,"RequesterID":500,"RequestedTime":"2024-06-15T10:00:00"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateRequestAvailableServiceUpdate a request for available service

Parameter	Type	Description
(body)	RequestAvailableService	Updated request

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RequestID":75,"Status":"Confirmed"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RequestID":75,"Status":"Confirmed"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RequestID":75,"Status":"Confirmed"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RequestID":75,"Status":"Confirmed"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RequestID\":75,\"Status\":\"Confirmed\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RequestID":75,"Status":"Confirmed"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateRequestAvailableService")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RequestID":75,"Status":"Confirmed"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetRequestsForAvailableService/{serviceId}Get all requests for a specific service

Parameter	Type	Description
serviceId	string	Service ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetRequestsForAvailableService/300")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Borrow / Lend / Share Operations

POSTBorrowResourceBorrow a resource from an owner

Parameter	Type	Description
(body)	Owner+Resource	Owner and Resource objects

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Owner":{"ContactID":500},"Resource":{"ResourceID":1000}}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Owner":{"ContactID":500},"Resource":{"ResourceID":1000}}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Owner":{"ContactID":500},"Resource":{"ResourceID":1000}};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Owner":{"ContactID":500},"Resource":{"ResourceID":1000}};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Owner\":{\"ContactID\":500},\"Resource\":{\"ResourceID\":1000}}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Owner":{"ContactID":500},"Resource":{"ResourceID":1000}};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/BorrowResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Owner":{"ContactID":500},"Resource":{"ResourceID":1000}}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTLendResourceLend a resource to a borrower

Parameter	Type	Description
(body)	Borrower+Resource	Borrower and Resource objects

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Borrower":{"ContactID":501},"Resource":{"ResourceID":1000}}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Borrower":{"ContactID":501},"Resource":{"ResourceID":1000}}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Borrower":{"ContactID":501},"Resource":{"ResourceID":1000}};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Borrower":{"ContactID":501},"Resource":{"ResourceID":1000}};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Borrower\":{\"ContactID\":501},\"Resource\":{\"ResourceID\":1000}}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Borrower":{"ContactID":501},"Resource":{"ResourceID":1000}};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LendResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Borrower":{"ContactID":501},"Resource":{"ResourceID":1000}}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTReclaimResourceReclaim a previously lent resource

Parameter	Type	Description
(body)	Resource	Resource to reclaim

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ReclaimResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTMakeResourceSharableMark a resource as sharable

Parameter	Type	Description
(body)	ResourceSharingInfo	Sharing info object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"IsShareable":true,"ShareType":"Public"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"IsShareable":true,"ShareType":"Public"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"IsShareable":true,"ShareType":"Public"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"IsShareable":true,"ShareType":"Public"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"IsShareable\":true,\"ShareType\":\"Public\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"IsShareable":true,"ShareType":"Public"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MakeResourceSharable")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"IsShareable":true,"ShareType":"Public"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTShareResourceWithGivenInfoShare a resource with specific sharing info

Parameter	Type	Description
(body)	Resource+ResourceSharingInfo+bool	Resource, sharing info, and share flag

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Resource":{"ResourceID":1000},"ResourceSharingInfo":{"ShareType":"Private"},"bShare":true}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Resource":{"ResourceID":1000},"ResourceSharingInfo":{"ShareType":"Private"},"bShare":true}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Resource":{"ResourceID":1000},"ResourceSharingInfo":{"ShareType":"Private"},"bShare":true};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Resource":{"ResourceID":1000},"ResourceSharingInfo":{"ShareType":"Private"},"bShare":true};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Resource\":{\"ResourceID\":1000},\"ResourceSharingInfo\":{\"ShareType\":\"Private\"},\"bShare\":true}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Resource":{"ResourceID":1000},"ResourceSharingInfo":{"ShareType":"Private"},"bShare":true};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ShareResourceWithGivenInfo")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Resource":{"ResourceID":1000},"ResourceSharingInfo":{"ShareType":"Private"},"bShare":true}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceSharingInfo/{ResourceId}Get sharing info for a resource

Parameter	Type	Description
ResourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfo/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetLentResources/{ownerId}Get resources currently lent by an owner

Parameter	Type	Description
ownerId	string	Owner user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetLentResources/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTLocateResourceGet the current location of a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LocateResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTGetCurrentScheduleForResourceGet the active schedule for a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCurrentScheduleForResource")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTGetResourceSpecificationsGet specifications for a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSpecifications")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetResourceSpecification/{resourceId}Set specifications for a resource

Parameter	Type	Description
resourceId	string	Resource ID
(body)	ResourceSpecification	Specification object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Weight":5000,"Length":20,"Width":8,"Height":13}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Weight":5000,"Length":20,"Width":8,"Height":13}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Weight":5000,"Length":20,"Width":8,"Height":13};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Weight":5000,"Length":20,"Width":8,"Height":13};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Weight\":5000,\"Length\":20,\"Width\":8,\"Height\":13}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Weight":5000,"Length":20,"Width":8,"Height":13};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetResourceSpecification/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Weight":5000,"Length":20,"Width":8,"Height":13}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTGetResourceCurrentStatusGet the current status of a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCurrentStatus")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTSetCostingModelSet a costing model for a resource

Parameter	Type	Description
(body)	ResourceCostingModel	Costing model object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"PricePerUnit\":25.00,\"Unit\":\"hour\",\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetCostingModel")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTGetCostingModelGet costing model for a resource

Parameter	Type	Description
(body)	Resource	Resource object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCostingModel")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTInsertResourceSharingInfoInsert a resource sharing info record

Parameter	Type	Description
(body)	ResourceSharingInfo	ResourceSharingInfo object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"ShareType":"Public","IsShareable":true}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"ShareType":"Public","IsShareable":true}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"ShareType":"Public","IsShareable":true};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"ShareType":"Public","IsShareable":true};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"ShareType\":\"Public\",\"IsShareable\":true}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"ShareType":"Public","IsShareable":true};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceSharingInfo")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"ShareType":"Public","IsShareable":true}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceSharingInfoById/{resourceId}Get sharing info records by resource ID

Parameter	Type	Description
resourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceSharingInfoById/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAChallangeForTheAction/{action}Get a challenge token for a sensitive action

Parameter	Type	Description
action	string	Action name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAChallangeForTheAction/DeleteResource")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRespondToChallenge/{action}/{id}/{response}Respond to a challenge for an action

Parameter	Type	Description
action	string	Action name
id	string	Resource or entity ID
response	string	Challenge response token

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RespondToChallenge/DeleteResource/1000/abc123token")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddRate/{resourceid}/{timeunit}/{minUnits}/{maxUnits}/{Rate}Add a rate/pricing tier for a resource

Parameter	Type	Description
resourceid	string	Resource ID
timeunit	string	Time unit (hour, day, week, month)
minUnits	string	Minimum units
maxUnits	string	Maximum units
Rate	string	Rate per unit

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddRate/1000/day/1/7/50.00")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAgreementTemplate/{strType}Get an agreement template by type

Parameter	Type	Description
strType	string	Agreement type (Lease, Service, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAgreementTemplate/Lease")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Shopping Cart

Shopping Cart Workflow: 1) Call GetIDForNewShoppingCart → 2) Add items with AddNewItemToShoppingCartSimplest → 3) Call PlaceOrderDetailed.

GETGetIDForNewShoppingCart/{strUserId}Create a new shopping cart; returns cart ID

Parameter	Type	Description
strUserId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetIDForNewShoppingCart/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNewShoppingCartGet a new empty ShoppingCart object

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNewShoppingCart")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetShoppingCartByUId/{cartUId}Get shopping cart by unique ID

Parameter	Type	Description
cartUId	string	Cart unique ID (UUID)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUId/cart-uuid-here")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetShoppingCartByCartId/{CartId}Get shopping cart by cart ID

Parameter	Type	Description
CartId	string	Cart numeric ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByCartId/5000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetShoppingCartByUserId/{UserId}Get shopping cart for a user

Parameter	Type	Description
UserId	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetShoppingCartByUserId/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateShoppingCartUpdate a shopping cart

Parameter	Type	Description
(body)	ShoppingCart	Updated ShoppingCart object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CartID":5000,"Status":"Active"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CartID":5000,"Status":"Active"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CartID":5000,"Status":"Active"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CartID":5000,"Status":"Active"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CartID\":5000,\"Status\":\"Active\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CartID":5000,"Status":"Active"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateShoppingCart")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CartID":5000,"Status":"Active"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteShoppingCart/{cartId}Delete a shopping cart

Parameter	Type	Description
cartId	string	Cart ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteShoppingCart/5000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddNewItemToShoppingCartSimplest/{Title}/{ResourceId}/{Count}/{Price}/{cartId}/{strIsVAS}Add an item to a cart (simplest form; currency defaults to USD)

Parameter	Type	Description
Title	string	Item title/name
ResourceId	string	Resource ID
Count	string	Quantity
Price	string	Price per unit
cartId	string	Shopping cart ID
strIsVAS optional	string	Is Value-Added Service (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplest/Parking Spot A1/1000/1/25.00/5000/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddNewItemToShoppingCartSimplestComprehensive/{Title}/{ResourceId}/{Count}/{ServiceId}/{Price}/{cartId}/{strIsVAS}Add an item to a cart with service ID

Parameter	Type	Description
Title	string	Item title
ResourceId	string	Resource ID
Count	string	Quantity
ServiceId	string	Service ID
Price	string	Price
cartId	string	Cart ID
strIsVAS optional	string	Is VAS

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimplestComprehensive/Car Wash/1000/1/300/50.00/5000/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddNewItemToShoppingCartSimple/{Title}/{CollectionId}/{ResourceId}/{Count}/{ServiceId}/{Price}/{DateCreated}/{cartId}/{Status}Add an item to a cart with full collection info

Parameter	Type	Description
Title	string	Item title
CollectionId	string	Resource collection ID
ResourceId	string	Resource ID
Count	string	Count
ServiceId	string	Service ID
Price	string	Price
DateCreated	string	Date created
cartId	string	Cart ID
Status	string	Status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCartSimple/Parking/200/1000/1/300/25.00/2024-06-01/5000/Active")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddNewLeasedItemToShoppingCartSimple/{Title}/{ResourceId}/{Count}/{ServiceId}/{Price}/{DateCreated}/{strLeaseStartTime}/{strLeaseEndTime}/{cartId}/{Status}Add a leased item to a shopping cart

Parameter	Type	Description
Title	string	Item title
ResourceId	string	Resource ID
Count	string	Count
ServiceId	string	Service ID
Price	string	Monthly rent
DateCreated	string	Date created
strLeaseStartTime	string	Lease start date
strLeaseEndTime	string	Lease end date
cartId	string	Cart ID
Status	string	Status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewLeasedItemToShoppingCartSimple/Apartment 4B/1000/1/300/2500.00/2024-06-01/2024-07-01/2025-06-30/5000/Active")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTAddNewItemToShoppingCartAdd a cart item via CartItem object

Parameter	Type	Description
(body)	CartItem	CartItem object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CartID":5000,"ResourceID":1000,"Title":"Parking Spot","Count":1,"Price":25.00}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CartID":5000,"ResourceID":1000,"Title":"Parking Spot","Count":1,"Price":25.00}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CartID":5000,"ResourceID":1000,"Title":"Parking Spot","Count":1,"Price":25.00};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CartID":5000,"ResourceID":1000,"Title":"Parking Spot","Count":1,"Price":25.00};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CartID\":5000,\"ResourceID\":1000,\"Title\":\"Parking Spot\",\"Count\":1,\"Price\":25.00}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CartID":5000,"ResourceID":1000,"Title":"Parking Spot","Count":1,"Price":25.00};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddNewItemToShoppingCart")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CartID":5000,"ResourceID":1000,"Title":"Parking Spot","Count":1,"Price":25.00}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetCartItemByItemId/{itemId}Get a specific cart item by ID

Parameter	Type	Description
itemId	string	Cart item ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByItemId/800")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetCartItemsForAShoppingCart/{cartId}Get all items in a shopping cart

Parameter	Type	Description
cartId	string	Cart ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemsForAShoppingCart/5000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetCartItemByCartIdAndStatus/{cartid}/{status}Get cart items filtered by status

Parameter	Type	Description
cartid	string	Cart ID
status	string	Item status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemByCartIdAndStatus/5000/Active")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetCartItemCountByCartId/{cartid}Get count of items in a cart

Parameter	Type	Description
cartid	string	Cart ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartItemCountByCartId/5000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTUpdateCartItemUpdate a cart item

Parameter	Type	Description
(body)	CartItem	Updated CartItem object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CartItemID":800,"Count":2,"Price":50.00}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CartItemID":800,"Count":2,"Price":50.00}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CartItemID":800,"Count":2,"Price":50.00};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CartItemID":800,"Count":2,"Price":50.00};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CartItemID\":800,\"Count\":2,\"Price\":50.00}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CartItemID":800,"Count":2,"Price":50.00};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateCartItem")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CartItemID":800,"Count":2,"Price":50.00}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteCartItem/{itemId}Delete a cart item

Parameter	Type	Description
itemId	string	Cart item ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteCartItem/800")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetCartTotalPrice/{ShoppingCartId}/{Currency}Calculate the total price for a shopping cart

Parameter	Type	Description
ShoppingCartId	string	Cart ID
Currency	string	Currency code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetCartTotalPrice/5000/USD")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Orders

GETPlaceOrder/{ShoppingCartId}/{Currency}Place an order from a shopping cart

Parameter	Type	Description
ShoppingCartId	string	Cart ID
Currency	string	Currency code

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrder/5000/USD")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETPlaceOrderDetailed/{ShoppingCartId}/{ShippingAddressId}/{Status}/{OrderFrequency}/{Currency}/{MethodOfPayment}/{BankAccountID}/{BankCardId}Place an order with shipping address and payment method

Parameter	Type	Description
ShoppingCartId	string	Cart ID
ShippingAddressId	string	Shipping address location ID
Status	string	Initial order status
OrderFrequency	string	Order frequency (Once, Monthly, etc.)
Currency	string	Currency code
MethodOfPayment	string	Payment method (CreditCard, BankAccount, etc.)
BankAccountID optional	string	Bank account ID (0 if not used)
BankCardId optional	string	Bank card ID (0 if not used)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailed/5000/400/Scheduled/Once/USD/CreditCard/0/0")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETPlaceOrderDetailedComprehensive/{ShoppingCartId}/{PickupAddressId}/{ShippingAddressId}/{Status}/{OrderFrequency}/{Currency}/{MethodOfPayment}/{BankAccountID}/{BankCardId}Place an order with pickup and shipping addresses

Parameter	Type	Description
ShoppingCartId	string	Cart ID
PickupAddressId	string	Pickup location ID
ShippingAddressId	string	Shipping location ID
Status	string	Initial status
OrderFrequency	string	Frequency
Currency	string	Currency
MethodOfPayment	string	Payment method
BankAccountID optional	string	Bank account ID
BankCardId optional	string	Bank card ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/PlaceOrderDetailedComprehensive/5000/401/400/Scheduled/Once/USD/CreditCard/0/0")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETProcessTransaction/{OrderNumber}/{strTransactionType}Process a transaction for an order

Parameter	Type	Description
OrderNumber	string	Order number string
strTransactionType	string	Transaction type (Sale, Refund, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ProcessTransaction/ORD-2024-001/Sale")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETRegisterTransaction/{OrderNumber}/{strTransactionType}/{strTransactionRefId}/{strProcessor}/{strEnvironment}/{strGatewayResponse}Register a transaction with processor details

Parameter	Type	Description
OrderNumber	string	Order number
strTransactionType	string	Transaction type
strTransactionRefId	string	Processor transaction reference ID
strProcessor	string	Processor name (Stripe, PayFac, etc.)
strEnvironment	string	Environment (Production, Sandbox)
strGatewayResponse optional	string	Gateway response string

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/RegisterTransaction/ORD-2024-001/Sale/TXN123456/Stripe/Production/Approved")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAssignOrder/{orderNumber}/{userId}Assign an order to a user (e.g., delivery person)

Parameter	Type	Description
orderNumber	string	Order number
userId	string	User ID to assign

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrder/ORD-2024-001/502")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAssignOrderToAUser/{orderid}/{userid}Assign an order to a user by IDs

Parameter	Type	Description
orderid	string	Order ID
userid	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AssignOrderToAUser/6000/502")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETUnAssignUserFromAnOrder/{orderid}Remove user assignment from an order

Parameter	Type	Description
orderid	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UnAssignUserFromAnOrder/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETOrderPickedUp/{orderNumber}Mark an order as picked up

Parameter	Type	Description
orderNumber	string	Order number

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderPickedUp/ORD-2024-001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETOrderDelivered/{orderNumber}Mark an order as delivered

Parameter	Type	Description
orderNumber	string	Order number

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderDelivered/ORD-2024-001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETOrderCompleted/{orderNumber}Mark an order as completed

Parameter	Type	Description
orderNumber	string	Order number

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/OrderCompleted/ORD-2024-001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTAddOrderInsert a new order

Parameter	Type	Description
(body)	Order	Order object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"CartID":5000,"PayerID":500,"Status":"Scheduled","Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"CartID":5000,"PayerID":500,"Status":"Scheduled","Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"CartID":5000,"PayerID":500,"Status":"Scheduled","Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"CartID":5000,"PayerID":500,"Status":"Scheduled","Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"CartID\":5000,\"PayerID\":500,\"Status\":\"Scheduled\",\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"CartID":5000,"PayerID":500,"Status":"Scheduled","Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrder")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"CartID":5000,"PayerID":500,"Status":"Scheduled","Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateOrderUpdate an existing order

Parameter	Type	Description
(body)	Order	Updated Order object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"OrderID":6000,"Status":"InProgress"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"OrderID":6000,"Status":"InProgress"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"OrderID":6000,"Status":"InProgress"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"OrderID":6000,"Status":"InProgress"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"OrderID\":6000,\"Status\":\"InProgress\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"OrderID":6000,"Status":"InProgress"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrder")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"OrderID":6000,"Status":"InProgress"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetOrder/{orderId}Get an order by ID (full)

Parameter	Type	Description
orderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrder/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderShallow/{orderId}Get an order without deep-loading sub-objects

Parameter	Type	Description
orderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderShallow/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderByOrderNumber/{orderNumber}Get an order by order number

Parameter	Type	Description
orderNumber	string	Order number string

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderNumber/ORD-2024-001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderByOrderStatus/{orderStatus}Get orders by status

Parameter	Type	Description
orderStatus	string	Order status (Scheduled, InProgress, Completed, etc.)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderByOrderStatus/Scheduled")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderForPayer/{payerId}/{orderStatus}/{isShallow}Get orders for a specific payer filtered by status

Parameter	Type	Description
payerId	string	Payer user ID
orderStatus	string	Order status
isShallow	string	Shallow load (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForPayer/500/Scheduled/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderForOwner/{OwnerId}/{orderStatus}/{isShallow}Get orders for a resource owner

Parameter	Type	Description
OwnerId	string	Owner user ID
orderStatus	string	Order status
isShallow	string	Shallow load (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForOwner/501/InProgress/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderForDeliverer/{DelivererId}/{orderStatus}/{isShallow}Get orders assigned to a deliverer

Parameter	Type	Description
DelivererId	string	Deliverer user ID
orderStatus	string	Order status
isShallow	string	Shallow load

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForDeliverer/502/Scheduled/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderForResourceAndSpecificPayer/{strResourceID}/{strPayerId}/{orderStatus}/{isShallow}Get orders for a resource and specific payer

Parameter	Type	Description
strResourceID	string	Resource ID
strPayerId	string	Payer user ID
orderStatus	string	Status
isShallow	string	Shallow load

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/500/Scheduled/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderForResourceAndSpecificPayer/{strResourceID}/{orderStatus}/{isShallow}Get orders for a resource (all payers)

Parameter	Type	Description
strResourceID	string	Resource ID
orderStatus	string	Status
isShallow	string	Shallow load

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderForResourceAndSpecificPayer/1000/Scheduled/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetBookings/{strPayerID}/{orderStatus}Get booking app objects for a payer

Parameter	Type	Description
strPayerID	string	Payer user ID
orderStatus	string	Order status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetBookings/500/Scheduled")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourcesAssociatedWithOrders/{payerId}/{orderStatus}Get resources associated with orders for a payer

Parameter	Type	Description
payerId	string	Payer user ID
orderStatus	string	Order status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourcesAssociatedWithOrders/500/Completed")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrdersSimple/{PersonFor}/{Id}/{orderStatus}Get order IDs for a person type and ID

Parameter	Type	Description
PersonFor	string	Person type (Payer, Owner, Deliverer)
Id	string	User ID
orderStatus	string	Order status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrdersSimple/Payer/500/Scheduled")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderNumber/{OrderId}Get the order number string for an order ID

Parameter	Type	Description
OrderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderNumber/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderAssociatedListings/{OrderId}Get resource IDs associated with an order

Parameter	Type	Description
OrderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedListings/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderAssociatedTransactionId/{OrderId}Get the transaction ID associated with an order

Parameter	Type	Description
OrderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderAssociatedTransactionId/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderTotal/{orderId}Get the total price of an order

Parameter	Type	Description
orderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderTotal/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETCancelOrder/{orderNumber}Cancel an order by order number

Parameter	Type	Description
orderNumber	string	Order number

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/CancelOrder/ORD-2024-001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTAddOrderDetailsAdd a line item to an order

Parameter	Type	Description
(body)	OrderDetails	OrderDetails object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"OrderID":6000,"ResourceID":1000,"Count":1,"Price":25.00,"Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"OrderID":6000,"ResourceID":1000,"Count":1,"Price":25.00,"Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"OrderID":6000,"ResourceID":1000,"Count":1,"Price":25.00,"Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"OrderID":6000,"ResourceID":1000,"Count":1,"Price":25.00,"Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"OrderID\":6000,\"ResourceID\":1000,\"Count\":1,\"Price\":25.00,\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"OrderID":6000,"ResourceID":1000,"Count":1,"Price":25.00,"Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddOrderDetails")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"OrderID":6000,"ResourceID":1000,"Count":1,"Price":25.00,"Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateOrderDetailsUpdate an order line item

Parameter	Type	Description
(body)	OrderDetails	Updated OrderDetails

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ItemID":7000,"Count":2,"Price":50.00}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ItemID":7000,"Count":2,"Price":50.00}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ItemID":7000,"Count":2,"Price":50.00};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ItemID":7000,"Count":2,"Price":50.00};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ItemID\":7000,\"Count\":2,\"Price\":50.00}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ItemID":7000,"Count":2,"Price":50.00};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateOrderDetails")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ItemID":7000,"Count":2,"Price":50.00}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETDeleteOrderDetails/{itemId}Delete an order line item

Parameter	Type	Description
itemId	string	Order details item ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/DeleteOrderDetails/7000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetOrderDetails/{orderId}Get all line items for an order

Parameter	Type	Description
orderId	string	Order ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetOrderDetails/6000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetPastTransactions/{customerId}Get past transactions for a customer

Parameter	Type	Description
customerId	string	Customer user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetPastTransactions/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppOrderFor/{PersonFor}/{Id}/{orderStatus}/{isShallow}Get order app objects for a person

Parameter	Type	Description
PersonFor	string	Person type (Payer, Owner, Deliverer)
Id	string	User ID
orderStatus	string	Order status
isShallow optional	string	Shallow load

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppOrderFor/Payer/500/Scheduled/false")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Financial & Leases

GETAddLease/{resourceId}/{customerId}/{paymentAmount}/{billingFrequency}/{startDay}/{startMonth}/{startYear}/{endDay}/{endMonth}/{endYear}/{uptoDateUntilDay}/{uptoDateUntilMonth}/{uptoDateUntilYear}Add a lease agreement for a resource

Parameter	Type	Description
resourceId	string	Resource ID
customerId	string	Customer/tenant user ID
paymentAmount	string	Payment amount
billingFrequency	string	Billing frequency (Monthly, Weekly, etc.)
startDay	string	Lease start day
startMonth	string	Lease start month
startYear	string	Lease start year
endDay	string	Lease end day
endMonth	string	Lease end month
endYear	string	Lease end year
uptoDateUntilDay	string	Payment current through day
uptoDateUntilMonth	string	Payment current through month
uptoDateUntilYear	string	Payment current through year

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddLease/1000/500/2500.00/Monthly/1/7/2024/30/6/2025/1/8/2024")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETExtendLease/{resourceId}/{paymentAmount}/{endDay}/{endMonth}/{endYear}Extend an existing lease to a new end date

Parameter	Type	Description
resourceId	string	Resource ID
paymentAmount	string	Extension payment amount
endDay	string	New end day
endMonth	string	New end month
endYear	string	New end year

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ExtendLease/1000/2500.00/31/12/2025")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETMarkAccountAsPaidUntil/{resourceId}/{paymentAmount}/{methodOfPayment}/{referenceNumbers}/{endDay}/{endMonth}/{endYear}Record a payment and mark account as paid through a date

Parameter	Type	Description
resourceId	string	Resource ID
paymentAmount	string	Payment amount
methodOfPayment	string	Payment method
referenceNumbers	string	Payment reference numbers
endDay	string	Paid through day
endMonth	string	Paid through month
endYear	string	Paid through year

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/MarkAccountAsPaidUntil/1000/2500.00/BankAccount/REF123456/1/9/2024")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddSubscription/{subscriptionName}/{BillingFrequency}/{resourceId}/{userId}/{Amount}/{DistributionPercentage}/{AccountID}/{startDay}/{startMonth}/{startYear}/{endDay}/{endMonth}/{endYear}/{Status}Add a subscription for a resource

Parameter	Type	Description
subscriptionName	string	Subscription name
BillingFrequency	string	Billing frequency (Monthly, Annual, etc.)
resourceId	string	Resource ID
userId	string	Subscriber user ID
Amount	string	Subscription amount
DistributionPercentage	string	Revenue distribution percentage
AccountID	string	Bank account ID for payments
startDay	string	Start day
startMonth	string	Start month
startYear	string	Start year
endDay	string	End day
endMonth	string	End month
endYear	string	End year
Status	string	Subscription status

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddSubscription/Monthly Parking/Monthly/1000/500/250.00/100/67890/1/7/2024/30/6/2025/Active")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetSubscription/{orderNumber}Get subscription details by order number

Parameter	Type	Description
orderNumber	string	Order number

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscription/ORD-2024-001")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetSubscriptionForPayer/{payerId}Get all subscriptions for a payer

Parameter	Type	Description
payerId	string	Payer user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionForPayer/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetSubscriptionByResourceId/{resourceID}/{payerId}Get subscriptions for a resource and payer

Parameter	Type	Description
resourceID	string	Resource ID
payerId	string	Payer user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetSubscriptionByResourceId/1000/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGenerateAccountHistoryLedger/{userid}/{resourceid}Generate ledger of account history for a user and resource

Parameter	Type	Description
userid	string	User ID
resourceid	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GenerateAccountHistoryLedger/500/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETTotalOutstandingBalanceByAccount/{userid}Get outstanding balances grouped by account

Parameter	Type	Description
userid	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceByAccount/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETTotalOutstandingBalanceOfAResource/{userid}/{resourceid}Get total outstanding balance for a specific resource

Parameter	Type	Description
userid	string	User ID
resourceid	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalanceOfAResource/500/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETTotalOutstandingBalance/{userid}Get total outstanding balance for a user

Parameter	Type	Description
userid	string	User ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/TotalOutstandingBalance/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Valuation & Costing Models

GETGetResourceValue/{resourceId}/{useCache}Get the monetary value of a resource

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValue/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceValuation/{resourceId}/{useCache}Get the ResourceValuation object for a resource

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuation/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceValuationById/{rvId}/{useCache}Get a ResourceValuation by its ID

Parameter	Type	Description
rvId	string	Resource valuation ID
useCache optional	string	Use cache

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceValuationById/500/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTInsertResourceValuationCreate a resource valuation record

Parameter	Type	Description
(body)	ResourceValuation	ResourceValuation object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"Price":500000,"Currency":"USD","ValuationType":"Market"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"Price":500000,"Currency":"USD","ValuationType":"Market"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"Price":500000,"Currency":"USD","ValuationType":"Market"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"Price":500000,"Currency":"USD","ValuationType":"Market"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"Price\":500000,\"Currency\":\"USD\",\"ValuationType\":\"Market\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"Price":500000,"Currency":"USD","ValuationType":"Market"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuation")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"Price":500000,"Currency":"USD","ValuationType":"Market"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTInsertResourceValuationForResource/{resourceId}Insert a valuation for a resource by ID

Parameter	Type	Description
resourceId	string	Resource ID
(body)	ResourceValuation	ResourceValuation object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Price":500000,"Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Price":500000,"Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Price":500000,"Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Price":500000,"Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Price\":500000,\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Price":500000,"Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceValuationForResource/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Price":500000,"Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceValuation/{resourceId}Update a resource valuation

Parameter	Type	Description
resourceId	string	Resource ID
(body)	ResourceValuation	Updated valuation

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"Price":520000,"Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"Price":520000,"Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"Price":520000,"Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"Price":520000,"Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"Price\":520000,\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"Price":520000,"Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceValuation/1000")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"Price":520000,"Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetResourceCostingModelByResourceId/{resourceID}Get all costing models for a resource

Parameter	Type	Description
resourceID	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByResourceId/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceCostingModelById/{rcmID}Get a costing model by ID

Parameter	Type	Description
rcmID	string	Costing model ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelById/50")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetResourceCostingModelByIds/{rcmIds}Get multiple costing models by comma-separated IDs

Parameter	Type	Description
rcmIds	string	Comma-separated costing model IDs

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetResourceCostingModelByIds/50,51,52")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTInsertResourceCostingModelInsert a resource costing model

Parameter	Type	Description
(body)	ResourceCostingModel	ResourceCostingModel object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ResourceID\":1000,\"PricePerUnit\":25.00,\"Unit\":\"hour\",\"Currency\":\"USD\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertResourceCostingModel")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ResourceID":1000,"PricePerUnit":25.00,"Unit":"hour","Currency":"USD"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateResourceCostingModelUpdate a resource costing model

Parameter	Type	Description
(body)	ResourceCostingModel	Updated costing model

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"RCMID":50,"PricePerUnit":30.00}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"RCMID":50,"PricePerUnit":30.00}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"RCMID":50,"PricePerUnit":30.00};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"RCMID":50,"PricePerUnit":30.00};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"RCMID\":50,\"PricePerUnit\":30.00}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"RCMID":50,"PricePerUnit":30.00};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateResourceCostingModel")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"RCMID":50,"PricePerUnit":30.00}.to_json

response = http.request(req)
puts JSON.parse(response.body)

Transactions

POSTAddTransactionAdd a transaction record

Parameter	Type	Description
(body)	Transaction	Transaction object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"OrderID":6000,"Amount":25.00,"Currency":"USD","TransactionType":"Sale","ProcessorRefId":"TXN123"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"OrderID":6000,"Amount":25.00,"Currency":"USD","TransactionType":"Sale","ProcessorRefId":"TXN123"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"OrderID":6000,"Amount":25.00,"Currency":"USD","TransactionType":"Sale","ProcessorRefId":"TXN123"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"OrderID":6000,"Amount":25.00,"Currency":"USD","TransactionType":"Sale","ProcessorRefId":"TXN123"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"OrderID\":6000,\"Amount\":25.00,\"Currency\":\"USD\",\"TransactionType\":\"Sale\",\"ProcessorRefId\":\"TXN123\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"OrderID":6000,"Amount":25.00,"Currency":"USD","TransactionType":"Sale","ProcessorRefId":"TXN123"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddTransaction")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"OrderID":6000,"Amount":25.00,"Currency":"USD","TransactionType":"Sale","ProcessorRefId":"TXN123"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTUpdateTransactionUpdate a transaction record

Parameter	Type	Description
(body)	Transaction	Updated Transaction

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"TransactionID":9000,"Status":"Settled"}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"TransactionID":9000,"Status":"Settled"}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"TransactionID":9000,"Status":"Settled"};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"TransactionID":9000,"Status":"Settled"};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"TransactionID\":9000,\"Status\":\"Settled\"}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"TransactionID":9000,"Status":"Settled"};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/UpdateTransaction")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"TransactionID":9000,"Status":"Settled"}.to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetTransactions/{customerID}/{productServiceID}Get transactions for a customer and product/service

Parameter	Type	Description
customerID	string	Customer user ID
productServiceID	string	Resource or service ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactions/500/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetTransactionByTransactionRefIDProcessor/{TransactionRefIDProcessor}Get transactions by processor reference ID

Parameter	Type	Description
TransactionRefIDProcessor	string	Processor transaction reference ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionByTransactionRefIDProcessor/TXN123456")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetTransactionProperties/{TransactionId}Get properties for a transaction

Parameter	Type	Description
TransactionId	string	Transaction ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTransactionProperties/9000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTSetTransactionPropertiesSet properties for a transaction

Parameter	Type	Description
(body)	Transaction	Transaction with properties

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"TransactionID":9000,"Properties":[{"Name":"Source","Value":"App"}]}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"TransactionID":9000,"Properties":[{"Name":"Source","Value":"App"}]}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"TransactionID":9000,"Properties":[{"Name":"Source","Value":"App"}]};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"TransactionID":9000,"Properties":[{"Name":"Source","Value":"App"}]};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"TransactionID\":9000,\"Properties\":[{\"Name\":\"Source\",\"Value\":\"App\"}]}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"TransactionID":9000,"Properties":[{"Name":"Source","Value":"App"}]};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/SetTransactionProperties")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"TransactionID":9000,"Properties":[{"Name":"Source","Value":"App"}]}.to_json

response = http.request(req)
puts JSON.parse(response.body)

Notifications

GETNotify/{UserId}/{Type}/{Message}Send a notification to a user

Parameter	Type	Description
UserId	string	User ID
Type	string	Notification type (Email, SMS, Push, etc.)
Message	string	Notification message

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/Notify/500/Push/Your order is ready")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTInsertNotificationInsert notification records

Parameter	Type	Description
(body)	List[Notification]	List of Notification objects

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"UserID":500,"Type":"Push","Message":"Order confirmed","Timestamp":"2024-06-01T10:00:00"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"UserID":500,"Type":"Push","Message":"Order confirmed","Timestamp":"2024-06-01T10:00:00"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"UserID":500,"Type":"Push","Message":"Order confirmed","Timestamp":"2024-06-01T10:00:00"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"UserID":500,"Type":"Push","Message":"Order confirmed","Timestamp":"2024-06-01T10:00:00"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"UserID\":500,\"Type\":\"Push\",\"Message\":\"Order confirmed\",\"Timestamp\":\"2024-06-01T10:00:00\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"UserID":500,"Type":"Push","Message":"Order confirmed","Timestamp":"2024-06-01T10:00:00"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InsertNotification")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"UserID":500,"Type":"Push","Message":"Order confirmed","Timestamp":"2024-06-01T10:00:00"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetNotifications/{customerId}Get all notifications for a customer

Parameter	Type	Description
customerId	string	Customer user ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotifications/500")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNotificationForAGivenTime/{customerId}/{startTime}/{endTime}Get notifications within a time range

Parameter	Type	Description
customerId	string	Customer user ID
startTime	string	Start time
endTime	string	End time

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTime/500/2024-06-01/2024-06-30")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNotificationForAGivenTimeAndType/{customerId}/{startTime}/{endTime}/{type}Get notifications by type within a time range

Parameter	Type	Description
customerId	string	Customer user ID
startTime	string	Start time
endTime	string	End time
type	string	Notification type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForAGivenTimeAndType/500/2024-06-01/2024-06-30/Push")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNotificationForLastNDaysAndHours/{customerId}/{days}/{hours}Get notifications for the last N days and hours

Parameter	Type	Description
customerId	string	Customer user ID
days	string	Number of days
hours	string	Additional hours

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationForLastNDaysAndHours/500/7/0")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetNotificationOfType/{customerId}/{type}Get notifications of a specific type for a customer

Parameter	Type	Description
customerId	string	Customer user ID
type	string	Notification type

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetNotificationOfType/500/Push")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

POSTGetTopNNotificationOfType/{customerId}/{topN}Get top N notifications of a type (NotificationType in body)

Parameter	Type	Description
customerId	string	Customer user ID
topN	string	Number of notifications to get
(body)	NotificationType	Notification type enum

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '"Push"'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = "Push"
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = "Push";

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = "Push";
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "\"Push\"";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = "Push";
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetTopNNotificationOfType/500/10")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = "Push".to_json

response = http.request(req)
puts JSON.parse(response.body)

Instrumentation & IoT

POSTInstrumentScenario/{strScenarioID}/{strScenarioName}/{strFeatureFunctionName}/{strUserSessionId}/{strCustomerID}/{strMeasurementType}/{strMeasurement}/{strTimeStamp}Log a scenario instrumentation event

Parameter	Type	Description
strScenarioID	string	Scenario ID
strScenarioName	string	Scenario name
strFeatureFunctionName	string	Feature/function name
strUserSessionId	string	User session ID
strCustomerID	string	Customer ID
strMeasurementType	string	Measurement type (Latency, Error, etc.)
strMeasurement	string	Measurement value
strTimeStamp	string	Timestamp

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "property1": "value1",
  "property2": "value2"
}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {
  "property1": "value1",
  "property2": "value2"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {
  "property1": "value1",
  "property2": "value2"
};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {
  "property1": "value1",
  "property2": "value2"
};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\n  \"property1\": \"value1\",\n  \"property2\": \"value2\"\n}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {
  "property1": "value1",
  "property2": "value2"
};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/InstrumentScenario/SCN001/CheckoutFlow/PlaceOrder/SESS123/500/Latency/150ms/2024-06-01T10:00:00")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {
  "property1": "value1",
  "property2": "value2"
}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTAddInstrumentationAdd a single instrumentation record

Parameter	Type	Description
(body)	Instrumentation	Instrumentation object

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ScenarioName":"Login","FeatureFunction":"ValidateUser","Measurement":"200ms","CustomerID":500}'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = {"ScenarioName":"Login","FeatureFunction":"ValidateUser","Measurement":"200ms","CustomerID":500}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = {"ScenarioName":"Login","FeatureFunction":"ValidateUser","Measurement":"200ms","CustomerID":500};

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = {"ScenarioName":"Login","FeatureFunction":"ValidateUser","Measurement":"200ms","CustomerID":500};
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "{\"ScenarioName\":\"Login\",\"FeatureFunction\":\"ValidateUser\",\"Measurement\":\"200ms\",\"CustomerID\":500}";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = {"ScenarioName":"Login","FeatureFunction":"ValidateUser","Measurement":"200ms","CustomerID":500};
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentation")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = {"ScenarioName":"Login","FeatureFunction":"ValidateUser","Measurement":"200ms","CustomerID":500}.to_json

response = http.request(req)
puts JSON.parse(response.body)

POSTAddInstrumentationsAdd multiple instrumentation records

Parameter	Type	Description
(body)	List[Instrumentation]	List of instrumentation records

Code Examples

curl -X POST "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"ScenarioName":"Checkout","Measurement":"300ms"}]'

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
    "Content-Type": "application/json"
}
payload = [{"ScenarioName":"Checkout","Measurement":"300ms"}]
response = requests.post(url, headers=headers, json=payload)
print(response.json())

// Using async/await (place inside an async function)
const payload = [{"ScenarioName":"Checkout","Measurement":"300ms"}];

const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations",
  {
    method: "POST",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var payload = [{"ScenarioName":"Checkout","Measurement":"300ms"}];
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

String jsonBody = "[{\"ScenarioName\":\"Checkout\",\"Measurement\":\"300ms\"}]";
MediaType JSON = MediaType.get("application/json");
RequestBody reqBody = RequestBody.create(jsonBody, JSON);

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .post(reqBody)
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
$payload = [{"ScenarioName":"Checkout","Measurement":"300ms"}];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddInstrumentations")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.request_uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"
req["Content-Type"] = "application/json"
req.body = [{"ScenarioName":"Checkout","Measurement":"300ms"}].to_json

response = http.request(req)
puts JSON.parse(response.body)

GETGetInstrumentation/{strScenarioName}Get instrumentation records by scenario name

Parameter	Type	Description
strScenarioName	string	Scenario name

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetInstrumentation/CheckoutFlow")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETAddMeasure/{deviceid}/{year}/{month}/{day}/{hour}/{minute}/{second}/{millisecond}/{measurename}/{measurevalue}Add a sensor/IoT measurement for a device

Parameter	Type	Description
deviceid	string	Device resource ID
year	string	Year
month	string	Month
day	string	Day
hour	string	Hour
minute	string	Minute
second	string	Second
millisecond	string	Millisecond
measurename	string	Measurement name
measurevalue	string	Measurement value

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/AddMeasure/900/2024/6/15/10/30/0/0/Temperature/22.5")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetActionOrder/{deviceid}Get pending action orders for a device

Parameter	Type	Description
deviceid	string	Device resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetActionOrder/900")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETLogVisit/{strResourceId}/{strPhoneNumber}/{strEmail}/{UUID}Log a visit/check-in to a resource

Parameter	Type	Description
strResourceId	string	Resource ID
strPhoneNumber optional	string	Visitor phone number
strEmail optional	string	Visitor email
UUID optional	string	Device UUID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogVisit/1000/5551234567/visitor@example.com/device-uuid")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETLogHits/{RemoteIPAddress}/{RemoteMACAddress}/{URL}/{URL_Referrer}/{MetaData}Log a web hit/request for analytics

Parameter	Type	Description
RemoteIPAddress	string	Remote IP address
RemoteMACAddress	string	Remote MAC address
URL	string	Requested URL
URL_Referrer	string	Referrer URL
MetaData	string	Additional metadata

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/LogHits/192.168.1.1/AA:BB:CC:DD:EE:FF/https://example.com/page/https://google.com/browser=Chrome")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETViewVisit/{strResourceId}Get visit log for a resource

Parameter	Type	Description
strResourceId	string	Resource ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/ViewVisit/1000")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

App Objects

GETGetAppObjectVehicleById/{resourceId}/{useCache}Get a vehicle as an AppObject_Vehicle by resource ID

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache (true/false)

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectVehicleById/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppRealEstateById/{resourceId}/{useCache}Get real estate as AppObjects_RealEstate by resource ID

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppRealEstateById/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppObjectProfessionalById/{resourceId}/{useCache}Get a professional as AppObject_Professional by resource ID

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppObjectProfessionalById/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppResourceById/{resourceId}/{useCache}Get a generic resource as AppObject_Resource by resource ID

Parameter	Type	Description
resourceId	string	Resource ID
useCache optional	string	Use cache

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppResourceById/1000/true")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

GETGetAppLocationById/{locationid}Get a location as AppObjects_Address by location ID

Parameter	Type	Description
locationid	string	Location ID

Code Examples

curl "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400" \
  -H "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"

import requests

url = "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400"
headers = {
    "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())

// Using async/await (place inside an async function)
const response = await fetch(
  "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400",
  {
    method: "GET",
    headers: {
      "FINERA-API-KEY": "YOUR_FINERA_JWT_TOKEN"
    }
  }
);
const data = await response.json();
console.log(data);

using System.Net.Http;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN");

var response = await client.GetAsync(
    "https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400");
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

// Using OkHttp 4.x
import okhttp3.*;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
    .url("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400")
    .addHeader("FINERA-API-KEY", "YOUR_FINERA_JWT_TOKEN")
    .get()
    .build();

try (Response response = client.newCall(request).execute()) {
    System.out.println(response.body().string());
}

<?php

$ch = curl_init("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "FINERA-API-KEY: YOUR_FINERA_JWT_TOKEN"
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>

require "net/http"
require "uri"
require "json"

uri = URI.parse("https://HostServiceIP_or_Domain/[ResourceServiceReferencePath].svc/GetAppLocationById/400")
req = Net::HTTP::Get.new(uri)
req["FINERA-API-KEY"] = "YOUR_FINERA_JWT_TOKEN"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts JSON.parse(response.body)

Authorization

Token Overview

The Finera platform uses three distinct credential types. Each request must include exactly one of them in the FINERA-API-KEY HTTP header.

Credential Type	Format	Used For	Scope
API Token (JWT)	`eyJ...`	Third-party integrations, agentic apps, MCP clients	Configurable per token — see Permissions Matrix below
Portal Backend Key	Opaque string	Customer-facing billing portal PHP pages calling WCF internally	Billing + FineraPay endpoints only; scoped to the portal account
Admin Key	Opaque string	Admin portal PHP pages, RunAutoRechargeCheck scheduler, admin-only endpoints	All endpoints including destructive/admin operations

Header name: All three credential types use the same header: FINERA-API-KEY: <value>. The server identifies the credential type by its format.

Permissions Matrix

API Tokens (JWT) issued via the admin token-management UI carry a set of AuthorizedServices and an optional AuthorizedAccount scope. The following services can be granted:

Service Code	What It Covers	Notes
All	Every endpoint on both WCF services	Use only for internal server-to-server integrations
ResourceService	All Resource Service endpoints (resources, scheduling, billing, FineraPay)
CustomerService	All Customer Service endpoints (users, bank cards, OTP)
BillingRead	Read-only billing: snapshots, invoices, usage, plans	Safe for analytics integrations
BillingWrite	Billing mutations: deposit, recharge config, plan assignment	Requires explicit grant; never issue to untrusted clients
FineraPay	RegisterPaymentMethod, GetPaymentMethodsForResource, TopUpWalletWithSavedCard	Needed for custom checkout integrations
MCP	MCP SSE/tool-call endpoints	Typically combined with ResourceService or All

AuthorizedAccount scoping: When AuthorizedAccount is set on a token, the WCF service enforces that every request's X-Portal-Account-Id header matches this value. This prevents a compromised token from reading data across accounts. Leave blank only for truly cross-account tokens (admin use).

Admin Key

The admin key is configured in FineraConfig.xml as <FineraAdminKey>. It bypasses the JWT validation layer entirely and grants access to all endpoints including admin-only operations like RunAutoRechargeCheck and wallet deposits.

Security: The admin key must never be exposed in client-side JavaScript or mobile apps. It is only used server-to-server (PHP admin portal → WCF, Task Scheduler → WCF).

Portal Backend Key

Defined in FineraConfig.xml as <PortalBackendToken>. The customer billing portal (PHP) uses this key when calling WCF on behalf of a logged-in merchant. It is combined with the X-Portal-Account-Id header to scope all results to that merchant's account.

Portal Request Pattern

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetBillingSnapshot/42" \
  -H "FINERA-API-KEY: PORTAL_BACKEND_TOKEN_HERE" \
  -H "X-Portal-Account-Id: 42"

<?php
// Standard pattern used by all customer billing portal PHP pages
$ch = curl_init(RESOURCE_API_BASE . 'GetBillingSnapshot/' . $accountId);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'FINERA-API-KEY: '      . PORTAL_BACKEND_TOKEN,
        'X-Portal-Account-Id: ' . $accountId,
        'Accept: application/json',
    ],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

Billing & Metering

All billing endpoints are on the Resource Service (RSServiceJSON.svc). A billing account corresponds 1:1 with a merchant or sub-merchant Resource — the accountId parameter is always the integer Resource.Id expressed as a string.

Base URL: http://<host>/SharingServiceJson/RSServiceJSON.svc/

Billing Account

GETGetBillingAccount/{accountId}Retrieve billing account details and current plan

Parameter	Type	Description
accountId	string	Merchant Resource ID (same as billing AccountId)

Response Fields

Field	Type	Description
AccountId	string	The resource ID
PlanId	int	Current billing plan ID
PlanName	string	Human-readable plan name
IsGrandfathered	bool	Locked to legacy pricing if true
BudgetCapAmount	decimal	Hard spend cap (0 = none)
WalletBalance	decimal	Current pre-paid wallet balance in USD

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetBillingAccount/42" \
  -H "FINERA-API-KEY: YOUR_TOKEN" \
  -H "X-Portal-Account-Id: 42"

const res = await fetch('/SharingServiceJson/RSServiceJSON.svc/GetBillingAccount/42', {
  headers: { 'FINERA-API-KEY': token, 'X-Portal-Account-Id': '42' }
});
const account = await res.json();

$res = billingApiGet('GetBillingAccount/' . $accountId, $accountId);

Snapshot & Balance

GETGetBillingSnapshot/{accountId}Full billing snapshot: balance, plan, allotments, period charges

Returns a comprehensive snapshot of the account's current billing state. This is the primary endpoint for the merchant dashboard and admin overview.

Key Response Fields

Field	Type	Description
WalletBalance	decimal	Current wallet balance (USD)
PlanName	string	Active plan name
BillingModelType	string	e.g. "Prepaid", "Postpaid"
PeriodStart	ISO-8601 date	Current billing period start
NextInvoiceDate	ISO-8601 date	When the next invoice runs
EstimatedPeriodCharge	decimal	Projected base charges this period
EstimatedOverageCharge	decimal	Projected overage charges this period
AutoRechargeEnabled	bool	Whether auto-recharge is active
Allotments	array	Each included-unit allotment with consumed/total/percent

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetBillingSnapshot/42" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

const snap = await fetch('.../GetBillingSnapshot/42', { headers: { 'FINERA-API-KEY': token } })
  .then(r => r.json());
console.log('Balance:', snap.WalletBalance, 'Plan:', snap.PlanName);

$snapRes = billingApiGet('GetBillingSnapshot/' . $accountId, $accountId);
$balance = $snapRes['data']['WalletBalance'] ?? 0;

Wallet Transactions

GETGetWalletTransactions/{accountId}Paginated wallet transaction history

Parameter	Type	Description
accountId	string	Merchant Resource ID
pagequery	int	Page number (default 1)
pageSizequery	int	Results per page (default 50, max 500)

Transaction Object Fields

Field	Type	Description
TransactionType	string	"Deposit", "Debit", "Refund", "Adjustment"
Amount	decimal	Positive = credit, negative = debit
BalanceAfter	decimal	Wallet balance immediately after this transaction
Reference	string	Description or external reference (e.g. Stripe PI ID)
TransactionUtc	ISO-8601	Transaction timestamp (UTC)

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetWalletTransactions/42?page=1&pageSize=50" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

const txs = await fetch('.../GetWalletTransactions/42?page=1&pageSize=50',
  { headers: { 'FINERA-API-KEY': token } }).then(r => r.json());

POSTDepositToWalletAdmin: credit funds to a merchant wallet

Requires Admin Key or a token with BillingWrite permission. Not available to merchant-scoped tokens.

Request Body

Field	Type	Description
AccountId	string	Merchant Resource ID
Amount	decimal	Amount in USD to credit
Notesoptional	string	Internal note (not shown to merchant)
TransactionTypeoptional	string	"Deposit" (default), "Refund", or "Adjustment"

Code Examples

curl -X POST "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/DepositToWallet" \
  -H "FINERA-API-KEY: ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"AccountId":"42","Amount":50.00,"Notes":"Promotional credit","TransactionType":"Deposit"}'

$ch = curl_init(RESOURCE_API_BASE . 'DepositToWallet');
curl_setopt_array($ch, [CURLOPT_POST=>true, CURLOPT_RETURNTRANSFER=>true,
  CURLOPT_POSTFIELDS=>json_encode(['AccountId'=>$accountId,'Amount'=>50.00,'TransactionType'=>'Deposit']),
  CURLOPT_HTTPHEADER=>['X-Finera-Admin-Key: '.FINERA_ADMIN_KEY,'Content-Type: application/json']]);
$result = curl_exec($ch); curl_close($ch);

Plans & Assignment

GETGetBillingPlansList all available billing plans

Returns all plans with their included allotments, overage rates, and billing model type. Used to populate the plan selection UI.

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetBillingPlans" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

POSTAssignBillingPlanToAccount/{accountId}Assign a plan to a merchant account

Requires BillingWrite permission or Admin Key.

Request Body

Field	Type	Description
PlanId	int	Plan ID from GetBillingPlans
EffectiveDateoptional	ISO-8601 date	When to switch (default: immediately)

Code Examples

curl -X POST "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/AssignBillingPlanToAccount/42" \
  -H "FINERA-API-KEY: ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"PlanId":3}'

Usage & Cost Reports

GETGetUsageByPeriod/{accountId}/{startDate}/{endDate}API call counts grouped by day or category

Parameter	Type	Description
accountId	string	Merchant Resource ID
startDate	YYYY-MM-DD	Period start (inclusive)
endDate	YYYY-MM-DD	Period end (inclusive)
groupByquery	string	"Day" (default) or "Category"

When groupBy=Day the response rows contain EventDate and ApiCallCount. When groupBy=Category they contain FeatureCategoryName, ApiCallCount, and Charge.

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetUsageByPeriod/42/2026-03-01/2026-03-31?groupBy=Day" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

$res = billingApiGet('GetUsageByPeriod/'.$accountId.'/'.date('Y-m-01').'/'.date('Y-m-d').'?groupBy=Day', $accountId);

GETGetCostByPeriod/{accountId}/{startDate}/{endDate}Itemised cost breakdown for a date range

Same parameters as GetUsageByPeriod. Returns cost-focused columns: BaseCharge, OverageCharge, TotalCharge per row.

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetCostByPeriod/42/2026-03-01/2026-03-31" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

Invoices

GETGetInvoicesByAccount/{accountId}List all invoices for an account

Returns all generated invoices with status, period dates, and total amounts. Invoice statuses: Pending, Completed, Failed.

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetInvoicesByAccount/42" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

Auto-Recharge Configuration

Auto-recharge automatically tops up the wallet when the balance drops below a configured threshold. The payment method is a FineraPay ft_xxx token saved on the account.

GETGetAutoRechargeConfig/{accountId}Get current auto-recharge settings

Response Fields

Field	Type	Description
Enabled	bool	Whether auto-recharge is active
Threshold	decimal	Recharge fires when balance drops below this amount (USD)
RechargeAmount	decimal	Amount to top up (USD)
PaymentMethodToken	string	FineraPay `ft_xxx` token to charge
MaxRechargesPerDay	int	Daily recharge limit (default 3)
LastRechargeStatus	string	"Success", "Failed", or empty if never run
LastRechargeAttemptUtc	ISO-8601	Last attempt timestamp
TodayRechargeCount	int	Number of successful recharges today (UTC)

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetAutoRechargeConfig/42" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

PUTSetAutoRechargeConfig/{accountId}Save auto-recharge settings

Request Body

Field	Type	Description
Enabled	bool	Enable or disable auto-recharge
ThresholdAmount	decimal	Balance threshold to trigger recharge
RechargeAmount	decimal	Amount to top up per recharge
PaymentMethodToken	string	FineraPay `ft_xxx` token — must be an off-session capable card
MaxRechargesPerDayoptional	int	Daily limit (default 3)

Off-session cards: The card used for auto-recharge must support off-session charges. Cards that require 3D Secure authentication cannot be used. Use a card that was registered and successfully charged in a portal session first.

Code Examples

curl -X PUT "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/SetAutoRechargeConfig/42" \
  -H "FINERA-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "AccountId": "42",
    "Enabled": true,
    "ThresholdAmount": 10.00,
    "RechargeAmount": 50.00,
    "PaymentMethodToken": "ft_abc123XYZ",
    "MaxRechargesPerDay": 3
  }'

$res = billingApiPost('SetAutoRechargeConfig/' . $accountId, $accountId, [
    'AccountId'          => $accountId,
    'Enabled'            => true,
    'ThresholdAmount'    => 10.00,
    'RechargeAmount'     => 50.00,
    'PaymentMethodToken' => $selectedFtToken,
    'MaxRechargesPerDay' => 3,
], 'PUT');

Run Recharge Check

GETRunAutoRechargeCheckProcess all pending auto-recharges (scheduler endpoint)

Admin only. Requires X-Finera-Admin-Key header. Called automatically by the Windows Task Scheduler every 15 minutes via Setup-AutoRechargeScheduler.ps1. Can also be called manually to trigger an immediate check.

For each enabled account whose wallet balance is below its threshold (and daily limit not reached), this endpoint: looks up the FineraPay card, calls Stripe to charge it, and credits the wallet via DepositToWallet.

Response Fields

Field	Type	Description
AccountsChecked	int	Total enabled accounts with a payment token
ChargesAttempted	int	Accounts where balance was below threshold
ChargesSucceeded	int	Successfully charged and credited
ChargesFailed	int	Failed charges (card declined, 3DS required, etc.)
Results	array	Per-account status: AccountId, Status, Message, NewBalance
RunAtUtc	ISO-8601	When this check ran

Status values in Results[]: Success, Failed, Skipped (no token), LimitReached (daily cap hit), BalanceOk (above threshold).

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/RunAutoRechargeCheck" \
  -H "X-Finera-Admin-Key: YOUR_ADMIN_KEY"

# Run immediately (same command used by Task Scheduler)
Invoke-WebRequest -Uri "http://localhost/SharingServiceJson/RSServiceJSON.svc/RunAutoRechargeCheck" `
  -Headers @{ 'X-Finera-Admin-Key' = $env:FINERA_ADMIN_KEY } | Select-Object -ExpandProperty Content

FineraPay

FineraPay is Finera's Stripe-backed payment method tokenisation system. Each saved card is represented as a Resource (Category: Payment) whose properties hold the Stripe pm_xxx and a Finera-issued opaque token (ft_xxx). Merchants never see raw card numbers; the platform stores only the Stripe payment method reference.

Overview & Concepts

Concept	Detail
ft_xxx token	HMAC-SHA256 derived opaque token. Formula: `ft_{base64url(HMAC-SHA256(FineraTokenSecret, userGUID + ":" + merchantGUID))}`. Deterministic — same card for the same user+merchant always produces the same token. Non-guessable without the secret.
Resource-as-PaymentMethod	Each card is stored as a child Resource of the merchant resource (ParentId = merchant ResourceId). ResourceProperties hold StripePmId, StripeCustomerId, FineraToken, Brand, Last4, ExpiryMonth, ExpiryYear, Provider, IsActive.
Stripe Customer (cus_xxx)	Created automatically per merchant resource on first card registration. Required for off-session charges (auto-recharge). Stored as the StripeCustomerId ResourceProperty on the merchant resource.
Provider field	"stripe" — reserved for future multi-provider support (Authorize.Net, PayPal, etc.).
FineraWalletEnabled	Per-merchant ResourceProperty. If set to "false" the portal hides FineraPay and disables card registration for that merchant.

Server-side GUID derivation: userGuid is read from User.SecretAnswer where SecretQuestion = "UniqueUserID". merchantGuid is read from ResourceProperty MerchantTenancyID (or PayFacTenancyID for PayFac-type resources). Client code does not need to supply these.

Register Card

POSTRegisterPaymentMethodSave a Stripe payment method as a FineraPay card

Called after stripe.createPaymentMethod() returns a pm_xxx ID on the client side. The server derives the ft_xxx token, creates/finds the Stripe Customer, attaches the pm to the Customer, and creates the card Resource.

Use finerapay.js (web) or the finera_pay Flutter package instead of calling this endpoint directly. The SDK handles the Stripe.js interaction and then calls this endpoint internally.

Request Body

Field	Type	Description
OwnerResourceId	int	Merchant Resource ID (AccountId) — the card will be owned by this resource
StripePmId	string	Stripe PaymentMethod ID (`pm_xxx`) from stripe.createPaymentMethod()
Provideroptional	string	"stripe" (default and only supported value currently)
BillingNameoptional	string	Cardholder name for display

Response Fields

Field	Type	Description
Success	bool	Whether the card was registered
FineraToken	string	The generated `ft_xxx` token for this card
ResourceId	int	Resource ID of the newly created card resource
Message	string	Human-readable result or error

Code Examples

curl -X POST "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/RegisterPaymentMethod" \
  -H "FINERA-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "OwnerResourceId": 42,
    "StripePmId": "pm_1AbcXYZ...",
    "Provider": "stripe",
    "BillingName": "Jane Doe"
  }'

// Recommended: use the finerapay.js SDK — it handles Stripe.js + this API call
FineraPay.init(STRIPE_PK, API_BASE, API_KEY);
FineraPay.mountCardElement('card-element');

const result = await FineraPay.addCard({
  ownerResourceId: 42,      // merchant accountId
  billingName: 'Jane Doe',  // optional
  provider: 'stripe'
});
// result.success === true  → result.token is the ft_xxx token

List Cards

GETGetPaymentMethodsForResource/{resourceId}List all FineraPay cards for a merchant

Parameter	Type	Description
resourceId	string	Merchant Resource ID

PaymentMethod Object Fields

Field	Type	Description
ResourceId	int	Card resource ID (use for DeregisterPaymentMethod)
FineraToken	string	`ft_xxx` — use this for TopUpWalletWithSavedCard and SetAutoRechargeConfig
Brand	string	"Visa", "Mastercard", "Amex", etc.
Last4	string	Last 4 digits of the card number
ExpiryMonth	string	Expiry month (1–12)
ExpiryYear	string	4-digit expiry year
IsActive	bool	Whether the card is currently usable for charges
Provider	string	"stripe"

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/GetPaymentMethodsForResource/42" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

# Response
{
  "PaymentMethods": [
    {
      "ResourceId": 105,
      "FineraToken": "ft_abc123XYZ...",
      "Brand": "Visa",
      "Last4": "4242",
      "ExpiryMonth": "12",
      "ExpiryYear": "2028",
      "IsActive": true,
      "Provider": "stripe"
    }
  ]
}

$fpRes   = billingApiGet('GetPaymentMethodsForResource/' . $accountId, $accountId);
$fpCards = $fpRes['data']['PaymentMethods'] ?? [];
// Filter to active cards only
$fpCards = array_filter($fpCards, fn($c) => !empty($c['IsActive']));

Remove Card

GETDeregisterPaymentMethod/{resourceId}Remove a saved FineraPay card

Parameter	Type	Description
resourceId	string	The card's `ResourceId` from GetPaymentMethodsForResource

Marks the card Resource as inactive and detaches the Stripe PaymentMethod. The resource is soft-deleted (not physically removed) to preserve transaction history.

Code Examples

curl "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/DeregisterPaymentMethod/105" \
  -H "FINERA-API-KEY: YOUR_TOKEN"

$res = billingApiGet('DeregisterPaymentMethod/' . $cardResourceId, $accountId);

Top-Up Wallet

POSTTopUpWalletWithSavedCardCharge a FineraPay card and credit the wallet

Creates a Stripe PaymentIntent for the saved card and, on success, credits the wallet via DepositToWallet. Handles both portal top-ups (user present) and auto-recharge (off-session, user absent).

Request Body

Field	Type	Description
AccountId	string	Merchant Resource ID
FineraToken	string	`ft_xxx` token from GetPaymentMethodsForResource
Amount	decimal	Amount to charge and credit (USD)
Currencyoptional	string	"usd" (default)
IsAutoRecharge	bool	true = off-session charge (background scheduler); false = portal top-up (user present)

Response Fields

Field	Type	Description
Success	bool	true if the wallet was credited
NewBalance	decimal	Updated wallet balance after top-up
RequiresAction	bool	true when 3DS authentication is needed — wallet NOT yet credited
ClientSecret	string	Stripe PaymentIntent client secret — pass to `stripe.confirmCardPayment()` when RequiresAction is true
StripePaymentIntentId	string	Stripe PI ID for reconciliation
Message	string	Human-readable result or error

Code Examples

curl -X POST "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/TopUpWalletWithSavedCard" \
  -H "FINERA-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "AccountId": "42",
    "FineraToken": "ft_abc123XYZ",
    "Amount": 50.00,
    "Currency": "usd",
    "IsAutoRecharge": false
  }'

const res = await fetch('.../TopUpWalletWithSavedCard', {
  method: 'POST',
  headers: { 'FINERA-API-KEY': token, 'Content-Type': 'application/json' },
  body: JSON.stringify({ AccountId: '42', FineraToken: 'ft_abc123', Amount: 50, Currency: 'usd', IsAutoRecharge: false })
}).then(r => r.json());

if (res.RequiresAction) {
  // 3DS required — see Confirm3DSWalletTopUp
  const stripe = Stripe(PUBLISHABLE_KEY);
  await stripe.confirmCardPayment(res.ClientSecret);
} else if (res.Success) {
  console.log('New balance:', res.NewBalance);
}

$res = billingApiPost('TopUpWalletWithSavedCard', $accountId, [
    'AccountId'      => $accountId,
    'FineraToken'    => $ftToken,
    'Amount'         => 50.00,
    'Currency'       => 'usd',
    'IsAutoRecharge' => false,
]);
if (!empty($res['data']['RequiresAction'])) {
    // store $res['data']['ClientSecret'] in session and redirect to 3DS flow
}

3DS Confirmation

POSTConfirm3DSWalletTopUpVerify completed 3DS authentication and credit wallet

Called after stripe.confirmCardPayment(clientSecret) returns status: "succeeded" on the client. The server re-verifies the PaymentIntent status with Stripe independently before crediting the wallet. This prevents replay attacks — the wallet is only credited if Stripe confirms the payment succeeded.

Complete 3DS Flow

POST to TopUpWalletWithSavedCard → receives RequiresAction: true + ClientSecret
Client calls stripe.confirmCardPayment(clientSecret)
On status === "succeeded": POST to Confirm3DSWalletTopUp
Server re-verifies with Stripe → credits wallet on confirmation

Request Body

Field	Type	Description
AccountId	string	Merchant Resource ID (cross-checked against PaymentIntent metadata)
PaymentIntentId	string	Stripe PaymentIntent ID (`pi_xxx`) from the TopUpWalletWithSavedCard response

Code Examples

// After stripe.confirmCardPayment() returns succeeded:
stripe.confirmCardPayment(clientSecret).then(async function(result) {
  if (result.paymentIntent && result.paymentIntent.status === 'succeeded') {
    const confirm = await fetch('.../Confirm3DSWalletTopUp', {
      method: 'POST',
      headers: { 'FINERA-API-KEY': token, 'Content-Type': 'application/json' },
      body: JSON.stringify({
        AccountId: '42',
        PaymentIntentId: result.paymentIntent.id
      })
    }).then(r => r.json());
    if (confirm.Success) console.log('Wallet credited. Balance:', confirm.NewBalance);
  }
});

// add-credits.php — action=3ds_complete handler
if ($action === '3ds_complete') {
    $piId = trim($_POST['payment_intent_id'] ?? '');
    $res = billingApiPost('Confirm3DSWalletTopUp', $accountId, [
        'AccountId'       => $accountId,
        'PaymentIntentId' => $piId,
    ]);
    if ($res['ok'] && ($res['data']['Success'] ?? false)) {
        $newBal = (float)($res['data']['NewBalance'] ?? 0);
    }
}

Stripe Connect Setup

POSTSetStripeConnectAccountIdAdmin: link a Stripe Connect account to a merchant resource

When set, TopUpWalletWithSavedCard routes charges via Stripe Connect (transfer_data.destination: acct_xxx) instead of the platform's single account. Requires Stripe Connect onboarding completed on Stripe's Dashboard. Use the Admin Portal's admin/accounts/stripe-connect.php page for a UI-based setup.

Admin Key required. Send ConnectAccountId: "" to revert to the single-account path.

Request Body

Field	Type	Description
ResourceId	string	Merchant Resource ID
ConnectAccountId	string	Stripe Connect account ID (`acct_xxx`) or empty string to clear

Code Examples

# Set
curl -X POST "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/SetStripeConnectAccountId" \
  -H "X-Finera-Admin-Key: ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ResourceId":"42","ConnectAccountId":"acct_1AbcXYZ123"}'

# Clear (revert to single-account)
curl -X POST "https://api.example.com/SharingServiceJson/RSServiceJSON.svc/SetStripeConnectAccountId" \
  -H "X-Finera-Admin-Key: ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ResourceId":"42","ConnectAccountId":""}'

SDKs

finerapay.js — Web SDK Overview

finerapay.js is the official Finera browser SDK. It wraps Stripe.js to provide a PCI-compliant card capture UI and handles all RegisterPaymentMethod and TopUpWalletWithSavedCard API calls. Your pages never touch raw card data.

Location: /js/finera.js served from the Finera web server. Always load https://js.stripe.com/v3/ before loading finerapay.js.

Include & Initialise

<!-- 1. Load Stripe.js -->
<script src="https://js.stripe.com/v3/"></script>

<!-- 2. Load the Finera SDK -->
<script src="/js/finera.js"></script>

<!-- 3. Initialise (values injected server-side from PHP config) -->
<script>
FineraPay.init(
  '<?= json_encode(STRIPE_PUBLISHABLE_KEY) ?>',  // Stripe publishable key
  '<?= json_encode(rtrim(RESOURCE_API_BASE,'/')) ?>',  // WCF base URL
  '<?= json_encode(PORTAL_BACKEND_TOKEN) ?>'   // Finera API key
);
</script>

addCard Flow

Mount the Stripe CardElement into a <div> on your page and call FineraPay.addCard() when the user submits. The SDK creates the Stripe PaymentMethod, calls RegisterPaymentMethod, and returns the ft_xxx token.

SDK Methods

Method	Signature	Description
FineraPay.init	`init(publishableKey, apiBase, apiKey)`	Must be called once before any other method
FineraPay.mountCardElement	`mountCardElement(containerId, style?)`	Mounts Stripe CardElement into the given DOM element ID
FineraPay.addCard	`addCard(opts) → Promise<{success, token, message}>`	Creates Stripe PM, calls RegisterPaymentMethod, returns ft_xxx
FineraPay.confirm3DS	`confirm3DS(clientSecret) → Promise`	Wraps stripe.confirmCardPayment() for 3DS flows
FineraPay.getCardElement	`getCardElement() → StripeCardElement`	Returns the mounted Stripe CardElement instance

addCard Options

Option	Type	Required	Description
ownerResourceId	int	Yes	Merchant Resource ID (billing accountId)
billingNameoptional	string	No	Cardholder name for display
provideroptional	string	No	"stripe" (default)

Complete Add-Card Example

<!-- Card element container -->
<input type="text" id="billing-name" placeholder="Name on card">
<div id="card-element"></div>
<div id="card-error" style="display:none;color:red"></div>
<button id="add-card-btn">Add Card</button>

<script>
FineraPay.mountCardElement('card-element');

document.getElementById('add-card-btn').addEventListener('click', async function() {
  this.disabled = true;
  document.getElementById('card-error').style.display = 'none';

  const result = await FineraPay.addCard({
    ownerResourceId: OWN_ID,                              // merchant accountId (from PHP)
    billingName:     document.getElementById('billing-name').value.trim() || undefined,
    provider:        'stripe'
  });

  this.disabled = false;
  if (result.success) {
    // Card saved — reload to show it in the list
    window.location.reload();
  } else {
    document.getElementById('card-error').textContent = result.message || 'Failed to add card.';
    document.getElementById('card-error').style.display = 'block';
  }
});
</script>

<?php
// payment-methods.php — initialise SDK with server-side values
?>
<script src="https://js.stripe.com/v3/"></script>
<script src="/js/finera.js"></script>
<script>
var OWN_ID = <?= (int)$accountId ?>;

FineraPay.init(
    <?= json_encode(STRIPE_PUBLISHABLE_KEY) ?>,
    <?= json_encode(rtrim(RESOURCE_API_BASE, '/')) ?>,
    <?= json_encode(PORTAL_BACKEND_TOKEN) ?>
);
</script>

Top-Up & 3DS Flow

Use the saved ft_xxx token to top up the wallet. If the card requires 3DS, the server returns RequiresAction: true with a ClientSecret. Use FineraPay.confirm3DS() to handle the authentication popup and then POST to Confirm3DSWalletTopUp.

Top-Up with 3DS Handling

// POST top-up request
const topup = await fetch(API_BASE + '/TopUpWalletWithSavedCard', {
  method: 'POST',
  headers: { 'FINERA-API-KEY': API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({ AccountId: accountId, FineraToken: ftToken, Amount: 50.0, Currency: 'usd', IsAutoRecharge: false })
}).then(r => r.json());

if (topup.Success) {
  // Instant success — wallet credited
  console.log('New balance:', topup.NewBalance);

} else if (topup.RequiresAction) {
  // 3DS needed
  const result = await FineraPay.confirm3DS(topup.ClientSecret);
  if (!result.error && result.paymentIntent.status === 'succeeded') {
    // Confirm server-side
    const confirm = await fetch(API_BASE + '/Confirm3DSWalletTopUp', {
      method: 'POST',
      headers: { 'FINERA-API-KEY': API_KEY, 'Content-Type': 'application/json' },
      body: JSON.stringify({ AccountId: accountId, PaymentIntentId: result.paymentIntent.id })
    }).then(r => r.json());
    if (confirm.Success) console.log('3DS wallet credited. Balance:', confirm.NewBalance);
  } else {
    console.error('3DS failed:', result.error?.message);
  }

} else {
  console.error('Payment failed:', topup.Message);
}

Flutter — finera_pay Package

The finera_pay Flutter package is Finera's official mobile payment SDK. It abstracts Stripe's Flutter SDK and all FineraPay WCF calls behind a clean Dart API. Mobile apps never import flutter_stripe directly — use finera_pay instead.

Publisher: fineratech.com on pub.dev | Source: Private Git repository (access granted per integration agreement).

Component	Description
FineraPayConfig	Initialisation: Stripe publishable key, API base URL, API key
FineraPayService	Core service: addCard(), topUpWallet(), listCards(), removeCard()
FineraCardField	Pre-built Flutter widget — PCI-compliant card input form
FineraPayButton	Composable button widget that invokes the full add-card flow

Setup & Initialisation

pubspec.yaml

dependencies:
  finera_pay:
    git:
      url: https://git.fineratech.com/finera_pay.git
      ref: main  # or pin to a release tag

# Do NOT add flutter_stripe directly — finera_pay re-exports what you need.

import 'package:finera_pay/finera_pay.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await FineraPayConfig.init(
    stripePublishableKey: 'pk_live_...',
    apiBase:             'https://api.example.com/SharingServiceJson/RSServiceJSON.svc',
    apiKey:              'YOUR_FINERA_JWT_TOKEN',
  );

  runApp(MyApp());
}

Adding a Card

Using FineraPayButton widget

import 'package:finera_pay/finera_pay.dart';

// Drop FineraPayButton into any screen
FineraPayButton(
  ownerResourceId: accountId,       // merchant accountId (int)
  billingNameController: _nameCtrl, // optional TextEditingController
  onSuccess: (String ftToken) {
    // card saved — ft_token is the ft_xxx FineraPay token
    setState(() => savedCards.add(ftToken));
  },
  onError: (String message) {
    ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text(message)));
  },
  child: Text('Add Card'),
)

import 'package:finera_pay/finera_pay.dart';

// Use FineraCardField for custom UI layout
final cardField = FineraCardField();

ElevatedButton(
  onPressed: () async {
    final result = await FineraPayService.instance.addCard(
      ownerResourceId: accountId,
      cardField:       cardField,
      billingName:     _nameController.text,
    );
    if (result.success) {
      print('ft_token: ' + result.token);   // ft_xxx
    } else {
      print('Error: ' + result.message);
    }
  },
  child: Text('Save Card'),
)

Top-Up Flow

Wallet Top-Up with 3DS Support

import 'package:finera_pay/finera_pay.dart';

Future<void> topUpWallet({
  required String accountId,
  required String ftToken,    // ft_xxx from listCards()
  required double amount,
}) async {
  final result = await FineraPayService.instance.topUpWallet(
    accountId:      accountId,
    fineraToken:    ftToken,
    amount:         amount,
    currency:       'usd',
    isAutoRecharge: false,
  );

  if (result.success) {
    print('Wallet credited. New balance: \$${result.newBalance}');
  } else if (result.requiresAction) {
    // SDK handles 3DS authentication sheet automatically
    // after sheet completes it calls Confirm3DSWalletTopUp
    final confirmed = await FineraPayService.instance.handle3DS(result);
    if (confirmed.success) {
      print('3DS complete. Balance: \$${confirmed.newBalance}');
    } else {
      print('3DS failed: ${confirmed.message}');
    }
  } else {
    print('Payment failed: ${result.message}');
  }
}

// List saved cards for the account
Future<List<FineraCard>> getSavedCards(String accountId) {
  return FineraPayService.instance.listCards(accountId: accountId);
}

// Remove a card
Future<void> removeCard(int cardResourceId, String accountId) {
  return FineraPayService.instance.removeCard(
    cardResourceId: cardResourceId,
    accountId:      accountId,
  );
}