Result | Medicomp Docs

curl -G https://quippe.medicomp.com/api/Quippe/Enum/Result \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d Capitalization=Title \
     -d OrderBy=Description \
     -d DataFormat=JSON \
     -d RequestId=req-20240612-001 \
     -d Culture=en-US

{
  "enum": {
    "item": [
      {
        "code": "ACTIVE",
        "description": "Active status indicating the item is currently in use",
        "displayOrder": 1,
        "flags": 0
      },
      {
        "code": "INACTIVE",
        "description": "Inactive status indicating the item is no longer in use",
        "displayOrder": 2,
        "flags": 0
      },
      {
        "code": "PENDING",
        "description": "Pending status indicating the item is awaiting approval",
        "displayOrder": 3,
        "flags": 0
      }
    ],
    "name": "StatusEnum"
  }
}

Retrieves the supported values in an enumeration list.

Authentication

AuthorizationBasic

Login and password used to access quippe.medicomp.com. On-premise Quippe deployments can be configured to use whatever authentication and authorization your application is configured for, so basic authentication is used here to access the Quippe sandbox and is not a product requirement.

AuthorizationBearer

JSON web token generated by a request to the /Quippe/Security/Token web service endpoint in Quippe.

Query parameters

CapitalizationenumOptional

The capitalization method, if any, that should be used to format the enum name.

OrderByenumOptional

The enum field, if any, that should be used to sort the results.

Allowed values:

DataFormatenumOptional

Specifies how objects are encoded in the output

Allowed values:

RequestIdstringOptional

Optional value that can be used by clients to track multiple requests.

CulturestringOptional

Culture to use when handling the request. If not specified the default value configured on the server will be used.

Response

Successful response

enumobjectOptional

Errors

401

Unauthorized Error

500

Internal Server Error