Category: Examples

ccb_dataTransaction

Purpose:

Applies a value pair array of data elements and values to a new or existing file. All the transactions are grouped as a form packed together as an event.

Service Parameters (json array)

  • serviceName (string) = “content”
  • function (string) = “ccb_dataTransaction”

Key Parameters

  • processID (string> Required
  • formID (string)
  • EventID (string)
  • parentID (string)
  • clientID (string)
  • fileID
  • ccbUserID
  • firstName (string) Required
  • lastName (string) Required
  • appendValues(boolean)
  • userID (string) Required (/li>
  • assignedTo (string) Required

    • Notes

    • If no EventID is provided, the service creates one based on the characteristics described in the ProcessID.
    • If no clientID is provided, the service creates one. If it creates a possible duplicate record, the service returns ClientIDs of the possible duplicates.
    • If no fileID is provided, the service creates one.
    • Depending on the settings of the ProcessID, the service will change the file status, generate automatic Events, generate additional data elements and identify the type of the transaction event as required.

      • Data Parameters

      A key value pair of any data element and it’s value.

    Results (json array)

    • Status (string).  (“0″=Success, “1”=Not Successful)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.

    stringParserTestExample

    Purpose:

    To demonstrate the utility to parse through a string to create an array of key/value pairs for data elements within the string.

    Parameters (json array)

    • serviceName (string) = “ama”
    • function (string) = “ama_stringParser”
    • Subject(string)
    • To(string)
    • From(string)
    • Body(string)

    Notes

    • If the string is an email, provide the key value pairs for the related data elements
    • If the string is not an email, put the string in the Body item.

    Results (json array)

    • Status (string).  (“0″=Success, “1”=Not Successfull)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.

    ama_stringParser

    Purpose:

    Parses through a string to create an array of key/value pairs for data elements within the string.

    Parameters (json array)

    • serviceName (string) = “ama”
    • function (string) = “ama_stringParser”
    • Subject(string)
    • To(string)
    • From(string)
    • Body(string)

    Notes

    • If the string is an email, provide the key value pairs for the related data elements
    • If the string is not an email, put the string in the Body item.

    Results (json array)

    • Status (string).  (“0″=Success, “1”=Not Successfull)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.

    Example

    TODO supply a title

    Example

    ama_addExportStat

    Purpose:

    Adds a statistic record to a Statistic table.

    Parameters (json array)

    • serviceName (string) = “ama”
    • function (string) = “ama_addExportStat”
    • tableName (string)

    Notes

    • Add a Key/Value pair for each column you want to add a counter for and it’s value.

    Results (json array)

    • Status (string).  (“0″=Success, “100”=Other)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example


    Click here for an example.

    ama_insertImportTableRecord

    Purpose:

    Insert a row into an UBERBase import table.

    Parameters (json array)

    • serviceName (string) = “ama”
    • function (string) = “ama_insertImportTableRecord”
    • tableName (string)
    • ID (string)
    • Key/Value pairs for each column with data.

    Notes

    • The table name can be any UBERBase import table.
    • If the ID is provided, the row is updated.

    Results (json array)

    • Status (string).  (“0″=Success, “1”=Not Successfull)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.

    ama_setImportTablesMatchedInd

    Purpose:

    Sets a row in an UBERBase import table to “Matched” to remove it from the work list.

    Parameters (json array)

    • serviceName (string) = “ama”
    • function (string) = “ama_setImportTablesMatchedInd”
    • tableName (string)
    • firstName (string)
    • lastName (string)
    • ID (string)

    Notes

    • The table name can be any UBERBase import table with a structure that includes a unique ID and a column called MatchedInd (matched indicator)

    Results (json array)

    • Status (string).  (“0″=Success, “1”=Not Successfull)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.

    cdd_getCodeValue

    Purpose:

    Get the value a coded possible value.

    Parameters (json array)

    • serviceName (string) = “dataDictionary”
    • function (string) = “cdd_getCodeValue”
    • codeValueID(string)
    • valueCol (string)

    Notes

    • The default column is Label_Med

    Results (json array)

    • Status (string).  (“0″=Success, “1”=Not Successfull)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.

    ama_searchImportTables

    Purpose:

    Searches a specified column of  a custom import table for rows that match ID, firstName (and/or) lastName, or a search string and returns an array of the results.

    Parameters (json array)

    • serviceName (string) = “ama”
    • function (string) = “ama_searchImportTables”
    • tableName (string)
    • firstName (string)
    • lastName (string)
    • ID (string)

    Notes

    • If the ID parameter is provided, the other parameters are ignored.

    Results (json array)

    • Status (string).  (“0″=Success, “100”=Other)
    • statusMessage (string) (“Empty”,”Results”)
    • data (json array) (the results if not empty)

    Example

    Click here for an example.