Get Support

Purpose

To get the support/Location of your Organization.

Support API accept post request with filter conditions. Response include filter supports array with matching conditions.

API return JSON array of supports.

Request URL

https://live.membroz.com/api/supports/filter

Request Method

POST

Note

Send authkey in https header
You must use only Field API names in the input. You can obtain the field API names from Fields metadata API
Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/supports
API will return matching records in array or error message.

Request JSON

Attribute	Data Type	Mandatory	Description
search	Array	yes	Add search fields to filter out return data. Example: { "search":[{ "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datattype": "text" }]} Only status = "active" records will return
select	Array		Add select fields to restrict return data schema. Example: Example: { "fieldname": "branchname", "value": 1 } Only branchname will return
sort	object		Sort return array based on sort input Example: { "branchname" : 1}
limit	number		limit return array size Example: limit: 10 only 10 records will return in the array

Sample Request

curl --location --request POST 'https://live.membroz.com/api/supports/filter' \
--header 'authkey: XXXXXXXXXX' \
--data-raw ''

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/supports/filter")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .build();
Response response = client.newCall(request).execute();

 "https://live.membroz.com/api/supports/filter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXX"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://live.membroz.com/api/supports/filter"

payload  = {}
headers = {
  'authkey': 'XXXXXXXXXX'}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/supports/filter")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXX"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://live.membroz.com/api/supports/filter");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddParameter("text/plain", "",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Possible Errors

HTTP Status	Error Code	Message	Reason
permission denied	403	You do not have permission

Sample Response

 {
        "_id": "5f746443d698d643837e2e36",
        "supportfor": "Member",
        "memberid": {
            "_id": "5e9598377fb65a4204aab603",
            "branchid": "5e954c7b9df11624f81e7859",
            "role": "59c1fb52b985482b2c610cee",
            "status": "active",
            "age": 0,
            "property": {
                "dob": "1949-10-28T00:29:12.071Z",
                "email": "jacob.kongsvik@example.com",
                "gender": "male",
                "city": "Bruflat",
                "country": "Norway",
                "postcode": "319",
                "state": "Nordland",
                "streetname": "Hartmanns vei",
                "streetnumber": 2051,
                "fullname": "Mr Jacob Kongsvik",
                "mobile_number": "93881418",
                "mobile_number_2": "28305346"
            },
            "username": "SAMPL10100",
            "membernumber": "SAMPL10100",
            "fullname": "Mr Jacob Kongsvik ",
            "membernumbername": "SAMPL10100 | Mr Jacob Kongsvik  | 93881418 | 28305346",
            "profilepic": "https://randomuser.me/api/portraits/men/6.jpg",
            "addons": [
                {
                    "paymentterms": [
                        "5ec7b001953ef63a4b7daf82"
                    ],
                    "_id": "5ecbc43b1e04ae5db687ec43",
                    "membershipid": "5e9598377fb65a4204aab631",
                    "membershipstart": "2020-05-25T18:42:28.112Z",
                    "membershipend": "2020-06-25T00:00:00.000Z"
                },
                {
                    "paymentterms": [
                        "5ec7b001953ef63a4b7daf82"
                    ],
                    "_id": "5ecbc4721e04ae5db687ec45",
                    "membershipid": "5e9598377fb65a4204aab619",
                    "membershipstart": "2020-05-25T18:43:22.410Z",
                    "membershipend": "2021-05-25T00:00:00.000Z"
                }
            ],
            "anroiddevices": [
                {
                    "_id": "5ecd0ee479b40e583fa638a2",
                    "deviceid": "e24b6f8ea1f0b710",
                    "registrationid": "c1Yc6eFDLJI:APA91bGU35yLz3k0Z3iZvU33Hmai--cAC_OkZs3-C2-DNr6PcxtBLk-f4UKT5EHMxTQPCJ92QzU1PSK4QbrbxAG98K3sSfjUrKIZMCwoGfCZ4fKMzI4AMTkwGE49GBbHBwwwSN6hwAeA"
                }
            ],
            "createdAt": "2020-04-13T05:26:25.273Z",
            "firsttimelogin": false,
            "iosdevices": [],
            "password": "$2a$10$odIB0nqCEmzj1jElflGdq.5fuawjKOAjpOJ5jAqh7SWhqU7mxWFEW",
            "paymentterms": [
                "5ec7b001953ef63a4b7daf82"
            ],
            "updatedAt": "2020-08-15T13:52:33.032Z",
            "membershipend": "2021-05-21T18:30:00.000Z",
            "membershipid": {
                "_id": "5e9598377fb65a4204aab619",
                "branchid": "5e954c7b9df11624f81e7859",
                "membershipname": "Massage - 12M - 24S",
                "price": 13544,
                "property": {
                    "membershipname": "Massage - 12M - 24S",
                    "tenure_month": 12
                },
                "status": "active",
                "tenure": 12
            },
            "membershipstart": "2020-05-22T18:30:00.000Z",
            "wfuserid": []
        },
        "response": []
    },