Create Groups - Security Category ID

Options
In the REST API documentation, it says that you can specify the Security Category ID when creating a group:

This method requires a Group Name and a Group Type, and can optionally accept a Group Description and Security Category ID, and will create a new static group in Luminate Online.


http://open.convio.com/api/?referrer=https://www.google.com/#group_api.createGroup_method.html


However, the name of the parameter isn't listed. I have tried countless different parameter names with no luck; the security category doesn't get set when creating a group.


What is the correct parameter name for security category when creating a group?


Thank you,

Jim Hart

Omatic Software
Tagged:

Comments

  • What did you try?


    I see that SecurityCategoryId is a field on the Group type in WebServices docs and in the WSDL for Group.


    https://webservices.cluster3.convio.net/1.0/ABC/wsdl


    When filtering on different gets it expects list_category_id, so you might try a few underscore variations like category_id.


    The returned data for a getGroup shows it as securityCategory.id
  • Hi Brian,


    I tried about 50 different parameter names including these:

    security_group_id

    security_category_id

    security_id

    category_id

    cat_id

    catid

    categoryid

    securitycategoryid

    securitygroup

    securitycategory

    category

    security_group

    security_category

    sec_cat_id

    list_category_id

    create_category_id


    I even tried passing in the id (i.e. 1) as well as the display name (i.e. General) with no luck.


    Either I missed a permutation of security, category, id and underscores or it's missing from the REST API for creating groups.


    I haven't tried a period seperator so I'll give that a try.

    (EDIT: no luck with periods either)


    Thanks!

    Jim Hart
  • If Noah Cooper doesn't weigh in, you might try reaching out to him. He'll know. He's here once in a while, or you can contact him from his github page. https://github.com/noahcooper


    Otherwise if you open a ticket an engineer would probably know, but that could take a while.


    Post what you find out!
  • The parameter is actually group_security_category_id. I'll open a bug about getting that documented!
  • Thanks Noah, group_security_category_id worked!
  • Is there a trick we could use to discover these on our own? There's listUserFields, but nothing similar for the other types.
  • There isn't unfortunately. I actually only knew because I looked at the underlying Java code used by this method.
  • Colleen Gutierrez
    Colleen Gutierrez Blackbaud Employee
    Ancient Membership 10 Comments 25 Likes Photogenic
    Thanks for bringing this to our attention! I'm not sure why that parameter was missed from the API docs since they are built from the code.


    The help was updated to add this parameter: http://open.convio.com/api/apidoc/reference/methods/createGroup_method.html


    Thanks!

Categories