GET API/V1/Customization/Frequencies

Request Information

URI Parameters

Name	Description	Type	Additional information
MedicationId	Filters to the frequencies allowed/configured for the specified medication.	integer	None.
ProcessId	Filters to the frequencies used by the specified treatment process.	integer	None.
Id	Direct lookup by Identifier.Id. When provided, all other filters are ignored; a non-matching id yields 404.	integer	None.
IsCustom	When true, returns only custom (site-defined) frequencies; when false, returns only fixed/hardcoded frequencies; when null, returns both.	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Customization.FrequencyCustomization

Name	Description	Type	Additional information
identifier	Primary identifier: Id (fixed negative id for the six hardcoded frequencies, real positive database id for custom frequencies), Code (external code, may be null), Description (frequency name, shown in the customization tool).	iMDsoft.API.Metavision.Data.Data.CodedElement	None.
isCustom	True when this is a site-defined custom frequency; false when it is one of the six fixed/hardcoded frequencies.	boolean	None.
customType	Custom frequency kind. One of: "daily", "weekly", "interval". Present only when is true; omitted from the response for fixed frequencies.	string	None.
properties	Type-specific configuration for a custom frequency, matching . Present only when is true; omitted from the response for fixed frequencies.	iMDsoft.API.Metavision.Data.Customization.FrequencyProperties	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "isCustom": true,
    "customType": "sample string 2",
    "properties": {
      "times": [
        "sample string 1",
        "sample string 2"
      ],
      "schedule": [
        {
          "dayOfWeek": "sample string 1",
          "time": "sample string 2"
        },
        {
          "dayOfWeek": "sample string 1",
          "time": "sample string 2"
        }
      ],
      "interval": {
        "value": 1,
        "unit": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "rounding": "sample string 2"
      }
    }
  },
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "isCustom": true,
    "customType": "sample string 2",
    "properties": {
      "times": [
        "sample string 1",
        "sample string 2"
      ],
      "schedule": [
        {
          "dayOfWeek": "sample string 1",
          "time": "sample string 2"
        },
        {
          "dayOfWeek": "sample string 1",
          "time": "sample string 2"
        }
      ],
      "interval": {
        "value": 1,
        "unit": {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        "rounding": "sample string 2"
      }
    }
  }
]