Get Branch data

Get Branch data

Purpose

To get the Branch/Location of your Organization.

Branch API accept post request with filter conditions. Response include filter branches array with matching conditions.

API return JSON array of branches.

Request URL

https://live.membroz.com/api/branches/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/branches
  • 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/branches/filter' \
--header 'authkey: XXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ "search":[{
    "searchfield": "status",
    "searchvalue": "active",
    "criteria": "eq",
    "datattype": "text"
}]}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"search\":[{\r\n    \"searchfield\": \"status\",\r\n    \"searchvalue\": \"active\",\r\n    \"criteria\": \"eq\",\r\n    \"datattype\": \"text\"\r\n}]}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/branches/filter")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/branches/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_POSTFIELDS =>"{ \"search\":[{\r\n    \"searchfield\": \"status\",\r\n    \"searchvalue\": \"active\",\r\n    \"criteria\": \"eq\",\r\n    \"datattype\": \"text\"\r\n}]}",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

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

payload = "{ \"search\":[{\r\n    \"searchfield\": \"status\",\r\n    \"searchvalue\": \"active\",\r\n    \"criteria\": \"eq\",\r\n    \"datattype\": \"text\"\r\n}]}"
headers = {
  'authkey': 'XXXXXXXXXXXXXXXX',
  'Content-Type': 'application/json'
}

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/branches/filter")

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

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{ \"search\":[{\r\n    \"searchfield\": \"status\",\r\n    \"searchvalue\": \"active\",\r\n    \"criteria\": \"eq\",\r\n    \"datattype\": \"text\"\r\n}]}"

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

var client = new RestClient("https://live.membroz.com/api/branches/filter");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{ \"search\":[{\r\n    \"searchfield\": \"status\",\r\n    \"searchvalue\": \"active\",\r\n    \"criteria\": \"eq\",\r\n    \"datattype\": \"text\"\r\n}]}",  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

[
    {
        "workinghours": {
            "days": [],
            "starttime": "8:0",
            "endtime": "18:0"
        },
        "status": "active",
        "_id": "XXXXXXXXXXXXX",
        "branchname": "All In One Gym",
        "billformat": {
            "invoiceformat": {
                "prefix": "AllIn",
                "format": 1,
                "header": "
$[{address}]    
",
                "headerinfo": "
  $[{memberid.membernumbername}]  
 
$[{memberid.membershipid.membershipname}]  
 
 $[{invoicenumberprefix}] - $[{invoicenumber}]
"
            },
            "receiptformat": {
                "prefix": "AllIn",
                "format": 1,
                "header": "
$[{address}]    
",
                "headerinfo": "
  $[{memberid.membernumbername}]  
 
$[{memberid.membershipid.membershipname}]  
 
 $[{receiptnumberprefix}] - $[{receiptnumber}]
"
            },
            "poformat": {
                "prefix": "AllIn",
                "format": 1,
                "header": "
$[{address}]    
",
                "headerinfo": "
  $[{memberid.membernumbername}]  
 
 $[{memberid.membershipid.membershipname}]  
 
 $[{billnumberprefix}] - $[{receiptnumber}]
"
            },
            "billingformat": {
                "prefix": "AllIn",
                "format": 1,
                "header": "
$[{address}]    
",
                "headerinfo": "
  $[{customerid.fullname}]  
 
  $[{customerid.membernumber}]  
 
 $[{customerid.membershipid.membershipname}]  
 
 $[{billprefix}] - $[{billnumber}]
 Date - $[{billingdate}]
"
            }
        },
        "solutiontype": "Gym, Yoga & Fitness Center",
        "property": {
            "country": "India"
        },
        "currency": "Indian rupee",
        "membershipidformat": "LLLLLLLLLLnnnnn",
        "startingnumber": "ALLIN-182-10000",
        "createdAt": "2020-06-17T08:57:58.040Z",
        "updatedAt": "2020-08-15T15:26:25.783Z",
        "branchlogo": "https://res.cloudinary.com/dlopjt9le/image/upload/v1586525260/mlh7afpkmoldnuo3qltc.png",
        "country": "IN",
        "timezone": "UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi"
    }
]