Get Specific Appointment Service

Get Specific Appointment Service

Purpose

To get the specific appointment of your organization.

Request URL

https://live.membroz.com/api/appointments/[appointmentid]

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/appointments
  • API return matching appointment data or return error message.

Request JSON

Attribute Data Type Mandatory Description
APPOINTMENTID String Yes The record ID of the appointment you want to update. it is pass in request
/api/appointments/[appointmentid]

Sample Request

curl --location --request GET 'https://live.membroz.com/api/appointments/[appointmentid]' \
--header 'authkey: XXXXXXXX'\
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
    ]
}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/appointments/[appointmentid]")
  .method("GET", null)
  .addHeader("authkey", "XXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/appointments/[appointmentid]",
  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 =>"{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://live.membroz.com/api/appointments/[appointmentid]"

payload = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"
headers = {
  'authkey': 'XXXXXXXX',
  '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/appointments/[appointmentid]")

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

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

response = https.request(request)
puts response.read_body
var client = new RestClient("https://live.membroz.com/api/appointments/[appointmentid]");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("authkey", "XXXXXXXX");
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

{
    "attendee": [
        "5f2408a16df10f60d3356621"
    ],
    "host": [],
    "status": "active",
    "_id": "5f24631b6df10f60d3356787",
    "date": "2020-08-03T00:00:00.000Z",
    "onModel": "Member",
    "charges": 0,
    "facilityid": "5f240bf16df10f60d3356656",
    "markingid": "3557425e-de63-48db-b553-383297b9f42f",
    "timeslotid": "2bf166e9-63eb-4ec7-a37e-d15027621a78",
    "timeslot": {
        "id": "2bf166e9-63eb-4ec7-a37e-d15027621a78",
        "day": "Monday",
        "starttime": "9:00",
        "endtime": "10:00"
    },
    "branchid": "5e954c7b9df11624f81e7859",
    "createdAt": "2020-07-31T18:29:47.460Z",
    "updatedAt": "2020-07-31T18:29:47.460Z",
    "updatedby": "5e954c7b9df11624f81e785b"
}
Send Message
Hello!
How can we help!