Get Membership Data

Purpose

To get the Membership/staff of your Organization.

Membership API accept post request with filter conditions. Response include filter membership array with matching conditions.

API return JSON array of membership.

Request URL

https://live.membroz.com/api/memberships/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/memberships
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/memberships/filter' \
--header 'authkey: XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
    ]
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/memberships/filter")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

setUrl('https://live.membroz.com/api/memberships/filter');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'authkey' => 'XXXXXXX',
  'Content-Type' => 'application/json'
));
$request->setBody('{ 
\n    "search": [
\n        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
\n    ]
\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

import requests

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

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

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

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

import requests

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

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

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

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

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

 {
        "_id": "5f5f16ec0cc8296e56de628a",
        "seasonupgrade": [],
        "addons": [],
        "status": "active",
        "membershipname": "Patinum",
      
        "memberhsipOffers": [],
        "packagesession": [],
        "property": {
            "tenure_month": 1,
            "membership_description": "abc",
            "membershipfees": 50000,
            "membershipname": "Patinum"
        },
        "createdAt": "2020-09-14T07:08:28.237Z",
        "updatedAt": "2020-09-14T07:08:28.237Z",
        "updatedby": "5e954c7b9df11624f81e785b",
        "addedby": "5e954c7b9df11624f81e785b"
    },