List supported sync capabilities

GET /v1/mosques/{mosqueId}/capabilities

List supported sync capabilities

cURL

curl --request GET \
  --url https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pocketmusala.com/v1/mosques/{mosqueId}/capabilities")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "version": "v1",
  "approvedProfileFields": [
    "communityName",
    "address",
    "latitude",
    "longitude",
    "timeZoneId"
  ],
  "supportedPrayerKeys": [],
  "resources": [
    "profile",
    "announcements",
    "prayers",
    "events",
    "sync"
  ],
  "scopes": {
    "read": "<string>",
    "write": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "troubleshooting": {
      "code": "<string>",
      "adminSummary": "<string>",
      "developerSummary": "<string>"
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "troubleshooting": {
      "code": "<string>",
      "adminSummary": "<string>",
      "developerSummary": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

PocketMusala Developer API key from the authenticated portal.

Headers

X-Request-Id · string

Partner-generated request id used for logs and support.

Minimum string length: 1

Path Parameters

mosqueId · string<uuid> · required

Response

200

application/json

Supported fields, prayer keys, resources, and scopes.

version · string · required

Example:

"v1"

approvedProfileFields · string[] · required

Example:

[
  "communityName",
  "address",
  "latitude",
  "longitude",
  "timeZoneId"
]

supportedPrayerKeys · enum<string>[] · required

Available options: fajr, sunrise, dhuhr, asr, maghrib, isha, midnight, tahajjud, duha, jummah, eid

resources · string[] · required

Example:

[
  "profile",
  "announcements",
  "prayers",
  "events",
  "sync"
]

scopes · object · required

Show child attributes