Get visible services

GET{{server}}/api/v1/dispenser/visibleServices?type=0

This endpoint returns the list of visible services of profile.

The type parameter value can be

• 0 - based on profile structure

• 1 - based on service matrix

• 2 - based on logged in clerks

Request

Authorization

Header	Value
Authorization	Apikey {{dispenserApikey}}

Headers

Key	Value
Accept	application/json
X-WSID	{{dispenserWsID}}

Query parameters

Key	Value
type	0

Code snippets

cURL

curl -X GET '{{server}}/api/v1/dispenser/visibleServices?type=0' \
  -H 'Accept: application/json' \
  -H 'X-WSID: {{dispenserWsID}}' \
  -H 'Authorization: Apikey {{dispenserApikey}}'

JavaScript

const response = await fetch("{{server}}/api/v1/dispenser/visibleServices?type=0", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-WSID": "{{dispenserWsID}}",
    "Authorization": "Apikey {{dispenserApikey}}"
  },
});

const data = await response.json();
console.log(data);

Python

import requests

url = "{{server}}/api/v1/dispenser/visibleServices?type=0"
headers = {
    "Accept": "application/json",
    "X-WSID": "{{dispenserWsID}}",
    "Authorization": "Apikey {{dispenserApikey}}"
}

response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())

Example

Example request

GET{{server}}/api/v1/dispenser/visibleServices?type=0

Query parameters (1)

Key	Value
type	0

Headers (2)

Key	Value
Accept	application/json
X-WSID	{{dispenserWsID}}

Example response 200 Ok

Response headers (9)

Key	Value
Access-Control-Expose-Headers	*
Cache-Control	no-store, no-cache, must-revalidate
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	POST, PUT, GET, OPTIONS, DELETE
Access-Control-Allow-Credentials	true
Content-Length	404
Access-Control-Max-Age	86400
Access-Control-Allow-Headers	Content-Type, Authorization, X-Requested-With
Content-Type	application/json;charset=utf-8

Body

{
  "services": [
    "00000000-0000-4000-0007-000000000001",
    "00000000-0000-4000-0007-000000000002",
    "00000000-0000-4000-0007-000000000006",
    "00000000-0000-4000-0007-000000000005",
    "18ed1ace-7774-441b-648f-98d54a257490",
    "18ed1aa2-c5a3-4946-8ba7-f71bb5ce69c1",
    "18ed1abe-b483-48ee-38e4-1029aafe62af",
    "00000000-0000-4000-0007-000000000004",
    "00000000-0000-4000-0007-000000000003",
    "18ed1ac5-8602-44e0-0e48-05356a4733ea"
  ]
}