I need to access a list of the Luminate API field names that correspond to the fields in LO

Options

Basically I need to access a list of the Luminate API field names that correspond to the fields in LO so that a third party can map some software. I have no experience with APIs and cannot figure out how to achieve this. Any help would be appreciated.

Tagged:

Comments

  • Derek Martin
    Derek Martin Blackbaud Employee
    Ancient Membership Facilitator 1 Name Dropper Photogenic

    @Brian Cramer Hi Brian, have you provided the third party with the Luminate Online API documentation?


  • @Derek Martin They would prefer that we provide them with a complete map of what fields we capture and the corresponding API field names as opposed to them completing it themselves but I can try this if all else fails.

  • @Brian Cramer
    Assuming you're talking about the REST API and not the SOAP one. It's ugly, but you can see the XML schema in pages like…

    …doesn't tell you much about which methods will be able to access those datapoints, but it does more or less tell you what's out there. @Derek Martin linked the REST API where you can find what those methods would be.

    If you were talking SOAP, then same portal has those too…the dev would need to look at the info for QUERY procedures, there's a WDSL for mapping everything out, and there's a DescribeType operation that narrows things down a bit.

    One other thing, “Roll Your Own API” method can also be used to make your own custom JSON responses based on S-Tags. That'd let you fire off whatever you can get from the constituent record using [[S1:foo]] or [[S48:cons_id-fr_id:cons.foo]]. Got some examples over on my GitHub, though I'm kinda in-process with fleshing out the documentation.

Categories