• OptionSet : This API allows you to interact with Acendre OptionSet objects.

      • Implementation Notes

        Returns a list of Option Sets.

        Response Class (Status 200)

        OptionSet response.

        [
          {
            "optionSetId": "6df5f8f4-c60d-4ea4-9e09-91ea245a7cff",
            "name": "Title",
            "validationType": "Strict",
            "options": [
              {
                "optionId": "",
                "displayValue": "Dr",
                "key": "Dr",
                "isActive": true
              }
            ],
            "apiAccessType": "UpdateOptionValues"
          }
        ]


        Response Messages

        HTTP Status Code Reason Response Model Headers
        400

        There was a problem with your request.

        401

        Unauthorized. The specified APIKey was not valid.

        403

        Forbidden. The consumer/subscription is disabled or you do not have access to it.

        404

        Consumer not found.

        500

        We experienced an internal server error processing your request.

      • Response Class (Status 200)

        OptionSet response.

        {
          "optionSetId": "6df5f8f4-c60d-4ea4-9e09-91ea245a7cff",
          "name": "Title",
          "validationType": "Strict",
          "options": [
            {
              "optionId": "",
              "displayValue": "Dr",
              "key": "Dr",
              "isActive": true
            }
          ],
          "apiAccessType": "UpdateOptionValues"
        }


        Parameters

        Parameter Value Description Parameter Type Data Type

        The optionSetId for the optionSet to get

        path string

        Response Messages

        HTTP Status Code Reason Response Model Headers
        400

        There was a problem with your request.

        401

        Unauthorized. The specified APIKey was not valid.

        403

        Forbidden. The consumer/subscription is disabled or you do not have access to it.

        404

        Consumer or OptionSet not found.

        500

        We experienced an internal server error processing your request.

      • Implementation Notes

        Creates a new option.

        Response Class (Status 201)

        OptionSet created.

        {
          "optionSetId": "6df5f8f4-c60d-4ea4-9e09-91ea245a7cff",
          "name": "Title",
          "validationType": "Strict",
          "options": [
            {
              "optionId": "",
              "displayValue": "Dr",
              "key": "Dr",
              "isActive": true
            }
          ],
          "apiAccessType": "UpdateOptionValues"
        }


        Parameters

        Parameter Value Description Parameter Type Data Type

        The optionSetId of the OptionSet to create this option in.

        path string


        OptionSet object

        body

        {
          "optionId": "",
          "displayValue": "Dr",
          "key": "Dr",
          "isActive": true
        }

        Click to set as parameter value

        Response Messages

        HTTP Status Code Reason Response Model Headers
        400

        There was a problem with your request.

        401

        Unauthorized. The specified APIKey was not valid.

        403

        Forbidden. The consumer/subscription is disabled or you do not have access to it.

        404

        Consumer or OptionSet not found.

        500

        We experienced an internal server error processing your request.

      • Response Class (Status 200)

        OptionSet response.

        {
          "optionSetId": "6df5f8f4-c60d-4ea4-9e09-91ea245a7cff",
          "name": "Title",
          "validationType": "Strict",
          "options": [
            {
              "optionId": "",
              "displayValue": "Dr",
              "key": "Dr",
              "isActive": true
            }
          ],
          "apiAccessType": "UpdateOptionValues"
        }


        Parameters

        Parameter Value Description Parameter Type Data Type

        The id of the optionSet the option is a part of

        path string

        The optionId of the option to get

        path string

        Response Messages

        HTTP Status Code Reason Response Model Headers
        400

        There was a problem with your request.

        401

        Unauthorized. The specified APIKey was not valid.

        403

        Forbidden. The consumer/subscription is disabled or you do not have access to it.

        404

        Consumer, OptionSet or Option not found.

        500

        We experienced an internal server error processing your request.

      • Implementation Notes

        Updates an option identified by its id.

        Parameters

        Parameter Value Description Parameter Type Data Type


        OptionSet object

        body

        {
          "optionId": "",
          "displayValue": "Dr",
          "key": "Dr",
          "isActive": true
        }

        Click to set as parameter value

        The optionSetId of the optionSet this option is a part of..

        path string

        The optionId of the option to update

        path string

        Response Messages

        HTTP Status Code Reason Response Model Headers
        204

        OptionSet successfully updated response.

        400

        There was a problem with your request.

        401

        Unauthorized. The specified APIKey was not valid.

        403

        Forbidden. The consumer/subscription is disabled or you do not have access to it.

        404

        Consumer, OptionSet or Option not found.

        500

        We experienced an internal server error processing your request.