SKY API Documentation Error

Hi,

Where should I be reporting documentation error? Here? Support Ticket?

There are currently 2 documentation errors:

  • FE - GL - Transaction Distribution List
    • Request parameter for last_modified “Returns modified records based on or after a specified date. Excludes time.
    • This is incorrect, I tested this parameter with no time (meaning time is 00:00:00) there are 467 results. Then tested this parameter with time specified (T20:00:00) there are 6 results (I know there are 6 transactions last modified ~22:38:00).
    • I think also best to indicate time in what time zone. For this endpoint, it is UTC time.
      • RE Gift List is actually NOT UTC time, the recorded last modified on gift record records the timezone, which I'm not sure if it is timezone of the user who changed it or timezone of the environment (I see a lot of -4 and -5, eastern daylight or not).
  • RE - Gift - Gift Custom Field List (All Gifts)
    • Request parameter for category Type is “array” and Description is “Represents a filter for custom field categories. Returns any custom fields that match the specified category. For example, category=Interests returns custom fields with the Interests category.”. Normally other type that is array allows for multiple to be specified (i.e. category=Category1&category=Category2). Does not work this way.
      • when multiple category is specified, you will get 200 status code, and API return for only the first category specified
    • If you look at Constituent Custom Field List (All Constituents), category is type array too but Description is “Represents a filter for a custom field category. Although the field is an array, the endpoint only returns custom fields that match a single specified category. For example, category=Interests returns custom fields with the Interests category.
      • when multiple category is specified, you will get 400 status code, and API return error message “The 'category' parameter only accepts one value. Please try this request again with only one value for the 'category' parameter.
    • I have reported this inconsistency in documentation months ago, and was told the documentation will be corrected, but it is still inconsistent today.

Comments

  • @Alex Wong I would recommend opening a support ticket, since it has been a few days and no replies in community. Thanks!

  • @Alex Wong
    Agree with Crystal about filing a ticket with Support.

    That said, I know this problem is actually a bug in our API gateway (Azure API Management) and is related to how it renders documentation for array parameters. This problem has been reported to Microsoft, but I don't believe a solution has been released.

Categories