Add Appointment Service

Add Appointment Service

Purpose

To add new Appointment/location to your organization.

Request URL

https://live.membroz.com/api/appointments

Request Method

POST
Note
  • Send authkey in https header
  • You can add only one appointment per POST request.
  • 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/appointments
  • API will return inserted appointment data in JSON format or error message.

Request JSON

Attribute Data Type Mandatory Description
appointmentname text yes appointment/location/company name
currency text
country text
timezone text
city text
companyphone text
contactperson text

Sample Request

curl --location --request POST 'https://live.membroz.com/api/appointments' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw ' {
        "_id": "5f1eb335796cb33b7ddcdb82",
        "attendee": [
           "5f02c2f9d31fed9cb2f4426a"
        ],
        "host": [],
        "status": "active",
        "date": "2020-07-28T00:00:00.000Z",
        "onModel": "Member",
        "charges": 10,
        "facilityid": "5ecbae7e1e04ae5db687ec0c",
        "markingid": "b928ffe4-2b97-41b9-8529-e07fbfb82d04",
        "timeslotid": "52deb26d-f70f-49c4-873d-71e80f768894",
        "timeslot": {
            "id": "52deb26d-f70f-49c4-873d-71e80f768894",
            "day": "Tuesday",
            "starttime": "10:00",
            "endtime": "11:00"
        },
        "branchid": "5e954c7b9df11624f81e7859",
        "createdAt": "2020-07-27T10:57:57.872Z",
        "updatedAt": "2020-07-27T10:57:57.872Z"
    }'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, " {\r\n        \"_id\": \"5f1eb335796cb33b7ddcdb82\",\r\n        \"attendee\": [\r\n           \"5f02c2f9d31fed9cb2f4426a\"\r\n        ],\r\n        \"host\": [],\r\n        \"status\": \"active\",\r\n        \"date\": \"2020-07-28T00:00:00.000Z\",\r\n        \"onModel\": \"Member\",\r\n        \"charges\": 10,\r\n        \"facilityid\": \"5ecbae7e1e04ae5db687ec0c\",\r\n        \"markingid\": \"b928ffe4-2b97-41b9-8529-e07fbfb82d04\",\r\n        \"timeslotid\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n        \"timeslot\": {\r\n            \"id\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n            \"day\": \"Tuesday\",\r\n            \"starttime\": \"10:00\",\r\n            \"endtime\": \"11:00\"\r\n        },\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"createdAt\": \"2020-07-27T10:57:57.872Z\",\r\n        \"updatedAt\": \"2020-07-27T10:57:57.872Z\"\r\n    }");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/appointments")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/appointments",
  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 =>" {\r\n        \"_id\": \"5f1eb335796cb33b7ddcdb82\",\r\n        \"attendee\": [\r\n           \"5f02c2f9d31fed9cb2f4426a\"\r\n        ],\r\n        \"host\": [],\r\n        \"status\": \"active\",\r\n        \"date\": \"2020-07-28T00:00:00.000Z\",\r\n        \"onModel\": \"Member\",\r\n        \"charges\": 10,\r\n        \"facilityid\": \"5ecbae7e1e04ae5db687ec0c\",\r\n        \"markingid\": \"b928ffe4-2b97-41b9-8529-e07fbfb82d04\",\r\n        \"timeslotid\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n        \"timeslot\": {\r\n            \"id\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n            \"day\": \"Tuesday\",\r\n            \"starttime\": \"10:00\",\r\n            \"endtime\": \"11:00\"\r\n        },\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"createdAt\": \"2020-07-27T10:57:57.872Z\",\r\n        \"updatedAt\": \"2020-07-27T10:57:57.872Z\"\r\n    }",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

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

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

payload = " {\r\n        \"_id\": \"5f1eb335796cb33b7ddcdb82\",\r\n        \"attendee\": [\r\n           \"5f02c2f9d31fed9cb2f4426a\"\r\n        ],\r\n        \"host\": [],\r\n        \"status\": \"active\",\r\n        \"date\": \"2020-07-28T00:00:00.000Z\",\r\n        \"onModel\": \"Member\",\r\n        \"charges\": 10,\r\n        \"facilityid\": \"5ecbae7e1e04ae5db687ec0c\",\r\n        \"markingid\": \"b928ffe4-2b97-41b9-8529-e07fbfb82d04\",\r\n        \"timeslotid\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n        \"timeslot\": {\r\n            \"id\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n            \"day\": \"Tuesday\",\r\n            \"starttime\": \"10:00\",\r\n            \"endtime\": \"11:00\"\r\n        },\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"createdAt\": \"2020-07-27T10:57:57.872Z\",\r\n        \"updatedAt\": \"2020-07-27T10:57:57.872Z\"\r\n    }"
headers = {
  'authkey': 'XXXXXXXXXX',
  '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/appointments")

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

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = " {\r\n        \"_id\": \"5f1eb335796cb33b7ddcdb82\",\r\n        \"attendee\": [\r\n           \"5f02c2f9d31fed9cb2f4426a\"\r\n        ],\r\n        \"host\": [],\r\n        \"status\": \"active\",\r\n        \"date\": \"2020-07-28T00:00:00.000Z\",\r\n        \"onModel\": \"Member\",\r\n        \"charges\": 10,\r\n        \"facilityid\": \"5ecbae7e1e04ae5db687ec0c\",\r\n        \"markingid\": \"b928ffe4-2b97-41b9-8529-e07fbfb82d04\",\r\n        \"timeslotid\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n        \"timeslot\": {\r\n            \"id\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n            \"day\": \"Tuesday\",\r\n            \"starttime\": \"10:00\",\r\n            \"endtime\": \"11:00\"\r\n        },\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"createdAt\": \"2020-07-27T10:57:57.872Z\",\r\n        \"updatedAt\": \"2020-07-27T10:57:57.872Z\"\r\n    }"

response = https.request(request)
puts response.read_body
var client = new RestClient("https://live.membroz.com/api/appointments");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", " {\r\n        \"_id\": \"5f1eb335796cb33b7ddcdb82\",\r\n        \"attendee\": [\r\n           \"5f02c2f9d31fed9cb2f4426a\"\r\n        ],\r\n        \"host\": [],\r\n        \"status\": \"active\",\r\n        \"date\": \"2020-07-28T00:00:00.000Z\",\r\n        \"onModel\": \"Member\",\r\n        \"charges\": 10,\r\n        \"facilityid\": \"5ecbae7e1e04ae5db687ec0c\",\r\n        \"markingid\": \"b928ffe4-2b97-41b9-8529-e07fbfb82d04\",\r\n        \"timeslotid\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n        \"timeslot\": {\r\n            \"id\": \"52deb26d-f70f-49c4-873d-71e80f768894\",\r\n            \"day\": \"Tuesday\",\r\n            \"starttime\": \"10:00\",\r\n            \"endtime\": \"11:00\"\r\n        },\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"createdAt\": \"2020-07-27T10:57:57.872Z\",\r\n        \"updatedAt\": \"2020-07-27T10:57:57.872Z\"\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": [
        "5f02c2f9d31fed9cb2f4426a"
    ],
    "host": [],
    "status": "active",
    "_id": "5f6c663ec97e67698f668748",
    "date": "2020-07-28T00:00:00.000Z",
    "onModel": "Member",
    "charges": 10,
    "facilityid": "5ecbae7e1e04ae5db687ec0c",
    "markingid": "b928ffe4-2b97-41b9-8529-e07fbfb82d04",
    "timeslotid": "52deb26d-f70f-49c4-873d-71e80f768894",
    "timeslot": {
        "id": "52deb26d-f70f-49c4-873d-71e80f768894",
        "day": "Tuesday",
        "starttime": "10:00",
        "endtime": "11:00"
    },
    "branchid": "5e954c7b9df11624f81e7859",
    "createdAt": "2020-09-24T09:26:22.378Z",
    "updatedAt": "2020-09-24T09:26:22.378Z",
    "updatedby": "5e954c7b9df11624f81e785b",
    "addedby": "5e954c7b9df11624f81e785b"
}
Send Message
Hello!
How can we help!