Get Specific Branch

Get Specific Branch

Purpose

To get the specific branch of your organization.

Request URL

https://live.membroz.com/api/branches/[branchid]

Request Method

GET
Note
  • Send authkey in https header
  • Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/branches
  • API return matching branch data or return error message.

Request JSON

Attribute Data Type Mandatory Description
BRANCHID String Yes The record ID of the branch you want to update. it is pass in request
/api/branches/[branchid]

Sample Request

curl --location --request GET 'https://live.membroz.com/api/branches/XXXXXXXXX' \
--header 'authkey: XXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ "search":[{
    "searchfield": "status",
    "searchvalue": "active",
    "criteria": "eq",
    "datattype": "text"
}]}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/branches/XXXXXXXXXXX")
  .method("GET", null)
  .addHeader("authkey", "XXXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/branches/XXXXXXXXXXX",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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: XXXXXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

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

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

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

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

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/branches/XXXXXXXXXXX")

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

request = Net::HTTP::Get.new(url)
request["authkey"] = "XXXXXXXXXXX"
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/XXXXXXXXXXX");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("authkey", "XXXXXXXXXXX");
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

{
    "workinghours": {
        "days": [],
        "starttime": "8:0",
        "endtime": "18:0"
    },
    "status": "active",
    "_id": "XXXXXXXXXXXXX",
    "branchname": "Utopia club",
    "billformat": {
        "invoiceformat": {
            "prefix": "Membo",
            "format": 1,
            "header": "
$[{address}]    
",
            "headerinfo": "
  $[{memberid.membernumbername}]  
 
$[{memberid.membershipid.membershipname}]  
 
 $[{invoicenumberprefix}] - $[{invoicenumber}]
"
        },
        "receiptformat": {
            "prefix": "Membo",
            "format": 1,
            "header": "
$[{address}]    
",
            "headerinfo": "
  $[{memberid.membernumbername}]  
 
$[{memberid.membershipid.membershipname}]  
 
 $[{receiptnumberprefix}] - $[{receiptnumber}]
"
        },
        "poformat": {
            "prefix": "Membo",
            "format": 1,
            "header": "
$[{address}]    
",
            "headerinfo": "
  $[{memberid.membernumbername}]  
 
 $[{memberid.membershipid.membershipname}]  
 
 $[{billnumberprefix}] - $[{receiptnumber}]
"
        },
        "billingformat": {
            "prefix": "Membo",
            "format": 1,
            "header": "Memborz Club",
            "headerinfo": "
$[{memberid.fullname}]
$[{memberid.membernumber}]
",
            "isbranchwise_billing": "branch"
        }
    },
    "solutiontype": "Club, Resort & Hotel",
    "property": {
        "country": "India"
    },
    "currency": "Indian rupee",
    "membershipidformat": "LLLLLnnnnn",
    "startingnumber": "MEMBO10000",
    "createdAt": "2020-05-27T11:35:52.420Z",
    "updatedAt": "2020-08-15T16:30:28.212Z",
    "branchlogo": "https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png",
    "country": "IN",
    "timezone": "UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi",
    "city": "",
    "companyphone": "61982-77123",
    "contactperson": "Mahi Patel",
    "postcode": "",
    "supportemail": "support@utopia.com",
    "supportnumber": null,
    "vatnumber": "A12-827-7640",
    "wfroleid": [],
    "wfuserid": []
}