Web Services

Tags

    HistoryEdited Aug 3, 2010 4:31 PM by Luke van der Westhuyzen…

    Standard Functions

    SOAP Service WSDL Parsing Functions


    _FmNx_Load_WSDL_From_URL( wsdl_name; URL )

    This is the preferred way to load a WSDL. When ever possible use this method to load a WSDL. This function allows you to load the WSDL function into your FileMaker solution. It will return the functions that successfully loaded. If it is unable to load the WSDL it will return and Error with details about why the WSDL did not load.

    This function follows all the same rules as a REST functions. If you need to authenticate to access this URL you will need to set the correct setting with _FmNx_SetPrefs for authentication. The URL field is URL encoded. We ignore the following characters during encoding |%!#$&'()*+,/:;=?@

    Inputs:
    wsdl_name - This is the name that will prefix the functions created for this WSDL.
    URL - This is the URL of where the WSDL resides. It is best to use the URL provided buy the Web Service provider. That is because if the WSDL uses a costume schema file the WSDL will know how to find it relative to the WSDL.

    Return:
    The names of the functions loaded for the specific WSDL.

    Example: _FmNx_Load_WSDL_From_URL( "VR"; "https://api.verticalresponse.com/partner-wsdl/1.0/VRAPI.wsdl" )


    _FmNx_Load_WSDL( wsdl_name; wsdl_document ) Deprecated

    This function is deprecated, and whenever possible you should use Load_WSDL_From_URL. However, there are some circumstances where a WSDL is inaccessible, and you can use this function to load the XML text of a WSDL from a FileMaker field. This function allows you to load the WSDL functions into your FileMaker solution. It will return the functions that successfully loaded. If it is unable to load the WSDL it will return and Error with details about why the WSDL did not load.

    Inputs:

    wsdl_name - This is the name that will prefix the functions created for this WSDL.

    wsdl_document - The content of a WSDL file

    Return:
    The names of the functions loaded for the specific WSDL.

    _FmNx_Unload( wsdl_name )

    You can use this function to remove the automatically created functions and preferences associated with a specific WSDL.


    _FmNx_Reload_All

    This function will unload all currently loaded WSDLs and reload any WSDLs found in the Extensions/wsdl folder. It will return the functions that successfully loaded. If it is unable to load the WSDL it will return and Error with details about why the WSDL did not load.

    It will not reload WSDLs loaded using _FmNx_Load_WSDL_From_URL or _FmNx_Load_WSDL.

    SOAP Service Request Functions

    There are no default functions for SOAP service requests. Functions are created automatically when the WSDL is loaded using _FmNx_Load_WSDL_From_URL.


    REST Service Request Functions

    All REST operations work for HTTP and HTTPS

    On all REST operations the URL field is URL encoded. We ignore the following characters during encoding |%!#$&'()*+,/:;=?@

    If you need to send content that uses any of these characters you will need to use FileMakers URL encoding function "GetAsUrlEncoded( text )" prior to including it in the URL.

    _FmNx_HTTP_DELETE( URL; {header; header ...} )

    The DELETE operation is used to delete a resource from the server.

    Inputs:

    URL - This is the URL that you are using to make your request. It will be URL encoded when it is sent.

    header - You may need to send specific or custom header information with your service. This allows you to add those headers.

    Results:

    This operation returns no data


    _FmNx_HTTP_GET( URL; format; {header; header ...} )

    This function is used to send a HTTP Get message. It will work for HTTP and HTTPS requests. Get operations are generally used to request something from a Web Service but not to update data on the Web Service.

    Inputs:

    URL - This is the URL that you are using to make your request. It will be URL encoded when it is sent.

    format - This is the format of the return data.

    • txt - This is text data. In many cases this is what you will be returning. It may be XML information.
    • jpeg/gif/png/bmp/pdf - These are all binary image data formats. You can put binary return data directly into container fields and it will show up as you would expect. This allows you to work with Web Services that return graphical data and present it directly in your FileMaker solution.

    header - You may need to send specific or custom header information with your service. This allows you to add those headers.

    Result:

    The return data will be data you requested from the service. We will package the data in the format specified in the format field.


    _FmNx_HTTP_POST( URL; post_data; format; {header; header ...} )

    This function is used to send a HTTP POST message. It will work for HTTP and HTTPS requests. POST is a tool to send data to a Web Service. It is generally used when you need to update data on a Web Service.

    Inputs:

    URL - This is the URL that you are using to make your request. It will be URL encoded when it is sent.

    post_data - This is just a block of data. No encoding is done on it. Depending on the service you are working with you may need to URL Encode this using the FileMaker function "GetAsUrlEncoded( text )". If the Data needs to be Base64 encoded we provide functions for that in the plugin. See _FmNx_Base64_Encode for more information.

    format - This is the format of the return data.

    • txt - This is text data. In many cases this is what you will be returning. It may be XML information.
    • jpeg/gif/png/bmp/pdf - These are all binary image data formats. You can put binary return data directly into container fields and it will show up as you would expect. This allows you to work with Web Services that return graphical data and present it directly in your FileMaker solution.

    header - You may need to send specific or custom header information with your service. This allows you to add those headers.

    Result:

    The return data will be data you requested from the service. We will package the data in the format specified in the format field.


    _FmNx_HTTP_PUT( URL; put_data; {header; header ...} )

    This function is used to send a HTTP PUT message. It will work for HTTP and HTTPS requests. PUT operations are generally used to upload a resource to a Web Service. For example this might be a file that is being uploaded.

    Inputs:

    URL - This is the URL that you are using to make your request. It will be URL encoded when it is sent.

    put_data - This is just a block of data. No encoding is done on it. Depending on the service you are working with you may need to URL Encode this using the FileMaker function "GetAsUrlEncoded( text )". If the data needs to be Base64 encoded we provide functions for that in the plugin. See _FmNx_Base64_Encode for more information.

    header - You may need to send specific or custom header information with your service. This allows you to add those headers.

    Results:

    This operation has no return data

    Response Parsing Functions


    _FmNx_JSON(json; query) // JSON Object and Array lookups


    _FmNx_XPATH_query( xml_document; xpath_query {; remove_tags; {namespaces_list}} ) // Note: XPATH is case sentitive - remove_tags is true or false - namespace_list must be in "<prefix1>=<href1> <prefix2>=href2> ..." format

    For more information on XPATH parsing, please see Beta Documentation: Parsing Responses with XPATH.


    Utility Functions


    _FmNx_Base64_Decode( base64_string; format ) // format can be an extension or a full filename (only jpeg/gif/png/bmp/pdf have previews)

    Frequently Web Services will Bases64 encode binary data. This function is used to decode that data.

    _FmNx_Base64_Encode( binary_data )

    Frequently Web Services will require biniary data to be Base64 encoded. This functions allows you to encode a block of data


    _FmNx_Version( short/long )

    This will return the current version of the plugin
    Example
    _FmNx_Version("short")
    Result will be something like "3.0.1"
    _FmNx_Version("long")
    Result will be something like "FM.NEXUS - Web Services 3.0.1"

    _FmNx_Register( license_key; owner )

    This function is used to register the plugin. The plugin can be used for an hour at a time with out registering it. Once you deploy your solution you will need to make sure you register the plugin every time the solution is launched.

    Inputs:
    license_key - This is the license key emailed to you when you purchased the plugin.

    owner - This is the name that you used when registering the plugin. It should also be included in the email with the license key.

    Result:
    If the registration was successful it will return "Success".

    If there is an error it will return "Error" followed by and error message explaining the error.

    Comments

    /groups/ws/search/index.rss?tag=hotlist/groups/ws/search/?tag=hotWhat’s HotHotListHot!?tag=hot0/groups/ws/sidebar/HotListNo items tagged with hot.hot/groups/ws/search/index.rss?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcomelist/groups/ws/search/?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcomeRecent ChangesRecentChangesListUpdates?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcome0/groups/ws/sidebar/RecentChangesListmodifiedDateallRecent ChangesRecentChangesListUpdateswiki/welcomeNo recent changes.reverse5search