Profil organizační jednotky¶

Prostředek profilu organizační jednotky umožňuje definovat a načíst informační profil pro organizační jednotky v DHIS 2.

/api/organisationUnitProfile

Lze vytvořit jeden profil organizační jednotky, který se vztahuje na všechny organizační jednotky.

Informační část profilu organizační jednotky zahrnuje:

• Název, zkrácený název, popis, nadřazená organizační jednotka, úroveň, datum otevření, datum ukončení, URL.
• Kontaktní osoba, adresa, e-mail, telefonní číslo (pokud existuje).
• Poloha (zeměpisná délka / šířka).
• Atributy metadat (konfigurovatelné).
• Sady a skupiny skupin organizačních jednotek (konfigurovatelné).
• Agregujte data pro datové prvky, indikátory, míry hlášení, programové indikátory (konfigurovatelné).

Vytvořte profil organizační jednotky¶

Chcete-li definovat profil organizační jednotky, můžete použít požadavek POST:

POST /api/organisationUnitProfile

Datový obsah ve formátu JSON vypadá takto, kde attributes odkazují na atributy metadat, groupSets odkazují na sady skupin organizačních jednotek a dataItems odkazují na datové prvky, indikátory, soubory dat a indikátory programu:

{
  "attributes": [
    "xqWyz9jNCA5",
    "n2xYlNbsfko"
  ],
  "groupSets": [
    "Bpx0589u8y0",
    "J5jldMd8OHv"
  ],
  "dataItems": [
    "WUg3MYWQ7pt",
    "vg6pdjObxsm",
    "DTVRnCGamkV",
    "Uvn6LCg7dVU",
    "eTDtyyaSA7f"
  ]
}

K definování profilu je vyžadováno oprávnění F_ORG_UNIT_PROFILE_ADD.

Get organisation unit profile¶

K načtení definice profilu organizační jednotky můžete použít požadavek GET

GET /api/organisationUnitProfile

Odpověď bude ve formátu JSON.

Get organisation unit profile data¶

Chcete-li načíst data profilu organizační jednotky, můžete použít požadavek GET

GET /api/organisationUnitProfile/{org-unit-id}/data?period={iso-period}

Koncový bod profilu dat organizační jednotky bude kombinovat definici profilu s přidruženými hodnotami informací / dat.

• Proměnná cesty org-unit-id je povinná a odkazuje na ID organizační jednotky, pro kterou se poskytují agregovaná data.
• Parametr dotazu iso-period je volitelný a odkazuje na ID období ISO pro období za účelem poskytnutí agregovaných dat pro datové položky. Pokud není zadán žádný, použije se jako nouzové období this year relativní období.

Odpověď bude zahrnovat následující části:

• info: Opravené informace o organizační jednotce.
• atributy: Atributy metadat s odpovídajícími hodnotami atributů.
• groupSets: Sady skupin organizačních jednotek s odpovídající skupinou organizačních jednotek, jejichž je organizační jednotka členem.
• dataItems: Datové položky s odpovídající hodnotou agregovaných dat.

Pamatujte, že jsou prováděny kontroly řízení přístupu a položky metadat, které nejsou aktuálnímu uživateli přístupné, budou vynechány.

Příklad požadavku vypadá takto:

GET /api/organisationUnitProfile/DiszpKrYNg8/data?period=2021

Obsah dat profilu ve formátu JSON bude vypadat takto, kde pole id alabel odkazují na položku metadat a pole value odkazuje na přidruženou hodnotu:

{
  "info": {
    "id": "DiszpKrYNg8",
    "code": "OU_559",
    "name": "Ngelehun CHC",
    "shortName": "Ngelehun CHC",
    "parentName": "Badjia",
    "level": 4,
    "levelName": "Facility",
    "openingDate": "1970-01-01T00:00:00.000",
    "longitude": -11.4197,
    "latitude": 8.1039
  },
  "attributes": [
    {
      "id": "n2xYlNbsfko",
      "label": "NGO ID",
      "value": "GHE51"
    },
    {
      "id": "xqWyz9jNCA5",
      "label": "TZ code",
      "value": "NGE54"
    }
  ],
  "groupSets": [
    {
      "id": "Bpx0589u8y0",
      "label": "Facility Ownership",
      "value": "Public facilities"
    },
    {
      "id": "J5jldMd8OHv",
      "label": "Facility Type",
      "value": "CHC"
    }
  ],
  "dataItems": [
    {
      "id": "WUg3MYWQ7pt",
      "label": "Total Population",
      "value": 3503
    },
    {
      "id": "DTVRnCGamkV",
      "label": "Total population < 1 year",
      "value": 140
    },
    {
      "id": "vg6pdjObxsm",
      "label": "Population of women of child bearing age (WRA)",
      "value": 716
    },
    {
      "id": "Uvn6LCg7dVU",
      "label": "ANC 1 Coverage",
      "value": 368.2
    },
    {
      "id": "eTDtyyaSA7f",
      "label": "FIC <1y",
      "value": 291.4
    }
  ]
}

Upload image for organisation unit¶

Chcete-li nahrát obrázek pro organizační jednotku, můžete použít koncový bod fileResources.

/api/fileResources

Koncový bod fileResource přijímá jako tělo požadavku nezpracovaný soubor. U obrázků organizačních jednotek jsou podporovány formáty JPG, JPEG a PNG. Doména pro obrázky organizační jednotky je ORG_UNIT.

Please consult File resources in the Metadata section for details about the fileResources endpoint.

Chcete-li nahrát obrázek, můžete odeslat požadavek POST s ORG_UNIT jako parametr dotazu domény spolu s obrázkem jako datovou částí požadavku. Záhlaví Content-Type by mělo odpovídat typu nahrávaného souboru.

POST /api/fileResources?domain=ORG_UNIT

Vlastnost id objektu response > fileResource v odpovědi JSON bude obsahovat odkaz na identifikátor zdroje souboru.

Entita organizační jednotky má vlastnost image, která odkazuje na obraz prostředku souboru. Chcete-li nastavit odkaz na souborový prostředek na organizační jednotce, můžete organizační jednotce odeslat požadavek PATCH s datovou částí JSON:

PATCH /api/organisationUnits/{id}

{ 
  "image": "{file-resource-id}" 
}

Alternativně můžete použít požadavek PUT s celým datovým obsahem organizační jednotky (pole jsou kvůli stručnosti vynechána):

PUT /api/organisationUnits/{id}

{
  "id": "Rp268JB6Ne4",
  "name": "Adonkia CHP",
  "image": {
    "id":  "{file-resource-iid}"
  }
}

Get image for organisation unit¶

Entita organizační jednotky má objekt image, který odkazuje na souborový zdroj podle identifikátoru. Informace o organizační jednotce můžete získat z koncového bodu organisationUnits. Pokud je nastaven, formát JSON vypadá takto:

GET /api/organisationUnits/{id}

{
  "id": "Rp268JB6Ne4",
  "name": "Adonkia CHP",
  "image": {
    "id":  "{file-resource-id}"
  }
}

Identifikátor prostředku obrazového souboru lze použít k vytvoření požadavku na koncový bod fileResources k načtení obsahu souboru:

GET /api/fileResources/{id}/data

Záhlaví Content-Type bude odrážet typ načítaného souboru.