Skip to main content
Solved

searching a simple API sample for activity based checklist

T
Sidekick (Customer)
Forum|alt.badge.img+7
  • tvg
  • Sidekick (Customer)
  • 39 replies

Hello,

in the past we already worked a lot with checklists. But only order related.

 

Now we have started also with first activity based checklist. For some reasons there is a need to fill a checklist in some cases automatically. (e. g. is an order is getting cancelled from customer)

Unfortunalety I don’t have any example API requests for activity based checklists, only for order related checklists.

Does anyone have a simple API example how to fill up an activity based checklist and could provide here?

 

Thanks a lot! 👍

Regards

Torsten

Best answer by Reid Gilbert

Hi Torsten,
I ran an activity checklist update from mobile and pulled the API from the “Inbound Data Audit (Integration)” module afterwards...you can capture these APIs automatically for your mobile user if you enable the Audit APIs toggle for the mobile technician in the Employees Security module:

 


The API syntax is as follows:

<root
    xmlns:dt="urn:schemas-microsoft-com:datatypes"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://astea.com.schema.bc.Service_Order">
    <session email="" alias="">
        <state bc_name="Service_Order">
            <action name="declare">
                <attribute dtype="string" in_var="" out_var="" name="strOrderID" value="" operator="=" />
                <attribute dtype="long" in_var="" out_var="" name="lngDemandId" value="" operator="=" />
            </action>
            <action name="getdescrex">
                <attribute in_var="" out_var="strOrderID" entity_name="service_order" key_name="surrogate_order_id" element_name="order_id" key_value="SV2407290007@@1" default_value="SV2407290007@@1" />
            </action>
            <action name="getdescrex">
                <attribute in_var="" out_var="lngDemandId" entity_name="demand_labor" key_name="surrogate_demand_id" element_name="demand_id" key_value="-2135633992" default_value="-2135633992" />
            </action>
            <action name="data">
                <main>
                    <row number="1">
                        <order_id dtype="string" in_var="strOrderID">in_var</order_id>
                        <cc_fx_api_order_update dtype="string">Y</cc_fx_api_order_update>
                    </row>
                </main>
                <demand_labor>
                    <row number="1" search_key="surrogate_demand_id;-2135633992">
                        <surrogate_demand_id dtype="string">-2135633992</surrogate_demand_id>
                        <cc_fx_api_actv_update dtype="string">Y</cc_fx_api_actv_update>
                        <bpart_id dtype="string">REID_ACTIVITY</bpart_id>
                        <sa_person_id dtype="string">rgilbert</sa_person_id>
                        <tzone_id dtype="string">Eastern Standard Time</tzone_id>
                        <bpart_descr dtype="string">REID_ACTIVITY</bpart_descr>
                        <estimated_dt dtype="date">7/30/2024</estimated_dt>
                        <estimated_tm dtype="date">09:18</estimated_tm>
                        <cc_mob_load_service_item dtype="string">Y</cc_mob_load_service_item>
                        <received_date dtype="date">7/30/2024</received_date>
                        <received_time dtype="date">09:18</received_time>
                    </row>
                </demand_labor>
                <checklist_for_order>
                    <row search_key="surrogate_result_id;-2135633999" number="1">
                        <surrogate_result_id dtype="string">-2135633999</surrogate_result_id>
                        <cl_id dtype="string">130</cl_id>
                        <entry_id dtype="string">908</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">confirmed the area is safe</result_value>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">1</seq_in_execution>
                        <seq_num_in_group dtype="string">1</seq_num_in_group>
                    </row>
                    <row search_key="surrogate_result_id;-2135633998" number="2">
                        <surrogate_result_id dtype="string">-2135633998</surrogate_result_id>
                        <cl_id dtype="string">130</cl_id>
                        <entry_id dtype="string">909</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">85</result_value>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">2</seq_in_execution>
                        <seq_num_in_group dtype="string">2</seq_num_in_group>
                    </row>
                    <row search_key="surrogate_result_id;-2135633997" number="3">
                        <surrogate_result_id dtype="string">-2135633997</surrogate_result_id>
                        <cl_id dtype="string">130</cl_id>
                        <entry_id dtype="string">910</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">-3</result_value>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">3</seq_in_execution>
                        <seq_num_in_group dtype="string">3</seq_num_in_group>
                    </row>
                    <row search_key="surrogate_result_id;-2135633996" number="4">
                        <surrogate_result_id dtype="string">-2135633996</surrogate_result_id>
                        <cl_id dtype="string">130</cl_id>
                        <entry_id dtype="string">1018</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">7/31/2024</result_value>
                        <result_value_date dtype="datetime">7/31/2024 13:20</result_value_date>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">4</seq_in_execution>
                        <seq_num_in_group dtype="string">4</seq_num_in_group>
                    </row>
                    <row search_key="surrogate_result_id;-2135633995" number="5">
                        <surrogate_result_id dtype="string">-2135633995</surrogate_result_id>
                        <cl_id dtype="string">289</cl_id>
                        <entry_id dtype="string">1842</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">597</result_value>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">5</seq_in_execution>
                        <seq_num_in_group dtype="string">1</seq_num_in_group>
                    </row>
                    <row search_key="surrogate_result_id;-2135633994" number="6">
                        <surrogate_result_id dtype="string">-2135633994</surrogate_result_id>
                        <cl_id dtype="string">289</cl_id>
                        <entry_id dtype="string">1843</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">598</result_value>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">6</seq_in_execution>
                        <seq_num_in_group dtype="string">2</seq_num_in_group>
                    </row>
                    <row search_key="surrogate_result_id;-2135633993" number="7">
                        <surrogate_result_id dtype="string">-2135633993</surrogate_result_id>
                        <cl_id dtype="string">289</cl_id>
                        <entry_id dtype="string">1844</entry_id>
                        <comments dtype="string"></comments>
                        <result_value dtype="string">599</result_value>
                        <result_status dtype="string">P</result_status>
                        <skip_line dtype="string">N</skip_line>
                        <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                        <added_by dtype="string">rgilbert</added_by>
                        <outstanding_action dtype="string">N</outstanding_action>
                        <seq_in_execution dtype="string">7</seq_in_execution>
                        <seq_num_in_group dtype="string">3</seq_num_in_group>
                    </row>
                </checklist_for_order>
            </action>
        </state>
    </session>
</root>

Thanks,
Reid

View original
    Did this topic help you find an answer to your question?

    2 replies

    Reid Gilbert
    Superhero (Employee)
    Forum|alt.badge.img+15
    • Reid Gilbert
    • Superhero (Employee)
    • 339 replies
    • Answer
    • July 30, 2024

    Hi Torsten,
    I ran an activity checklist update from mobile and pulled the API from the “Inbound Data Audit (Integration)” module afterwards...you can capture these APIs automatically for your mobile user if you enable the Audit APIs toggle for the mobile technician in the Employees Security module:

     


    The API syntax is as follows:

    <root
        xmlns:dt="urn:schemas-microsoft-com:datatypes"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://astea.com.schema.bc.Service_Order">
        <session email="" alias="">
            <state bc_name="Service_Order">
                <action name="declare">
                    <attribute dtype="string" in_var="" out_var="" name="strOrderID" value="" operator="=" />
                    <attribute dtype="long" in_var="" out_var="" name="lngDemandId" value="" operator="=" />
                </action>
                <action name="getdescrex">
                    <attribute in_var="" out_var="strOrderID" entity_name="service_order" key_name="surrogate_order_id" element_name="order_id" key_value="SV2407290007@@1" default_value="SV2407290007@@1" />
                </action>
                <action name="getdescrex">
                    <attribute in_var="" out_var="lngDemandId" entity_name="demand_labor" key_name="surrogate_demand_id" element_name="demand_id" key_value="-2135633992" default_value="-2135633992" />
                </action>
                <action name="data">
                    <main>
                        <row number="1">
                            <order_id dtype="string" in_var="strOrderID">in_var</order_id>
                            <cc_fx_api_order_update dtype="string">Y</cc_fx_api_order_update>
                        </row>
                    </main>
                    <demand_labor>
                        <row number="1" search_key="surrogate_demand_id;-2135633992">
                            <surrogate_demand_id dtype="string">-2135633992</surrogate_demand_id>
                            <cc_fx_api_actv_update dtype="string">Y</cc_fx_api_actv_update>
                            <bpart_id dtype="string">REID_ACTIVITY</bpart_id>
                            <sa_person_id dtype="string">rgilbert</sa_person_id>
                            <tzone_id dtype="string">Eastern Standard Time</tzone_id>
                            <bpart_descr dtype="string">REID_ACTIVITY</bpart_descr>
                            <estimated_dt dtype="date">7/30/2024</estimated_dt>
                            <estimated_tm dtype="date">09:18</estimated_tm>
                            <cc_mob_load_service_item dtype="string">Y</cc_mob_load_service_item>
                            <received_date dtype="date">7/30/2024</received_date>
                            <received_time dtype="date">09:18</received_time>
                        </row>
                    </demand_labor>
                    <checklist_for_order>
                        <row search_key="surrogate_result_id;-2135633999" number="1">
                            <surrogate_result_id dtype="string">-2135633999</surrogate_result_id>
                            <cl_id dtype="string">130</cl_id>
                            <entry_id dtype="string">908</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">confirmed the area is safe</result_value>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">1</seq_in_execution>
                            <seq_num_in_group dtype="string">1</seq_num_in_group>
                        </row>
                        <row search_key="surrogate_result_id;-2135633998" number="2">
                            <surrogate_result_id dtype="string">-2135633998</surrogate_result_id>
                            <cl_id dtype="string">130</cl_id>
                            <entry_id dtype="string">909</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">85</result_value>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">2</seq_in_execution>
                            <seq_num_in_group dtype="string">2</seq_num_in_group>
                        </row>
                        <row search_key="surrogate_result_id;-2135633997" number="3">
                            <surrogate_result_id dtype="string">-2135633997</surrogate_result_id>
                            <cl_id dtype="string">130</cl_id>
                            <entry_id dtype="string">910</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">-3</result_value>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">3</seq_in_execution>
                            <seq_num_in_group dtype="string">3</seq_num_in_group>
                        </row>
                        <row search_key="surrogate_result_id;-2135633996" number="4">
                            <surrogate_result_id dtype="string">-2135633996</surrogate_result_id>
                            <cl_id dtype="string">130</cl_id>
                            <entry_id dtype="string">1018</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">7/31/2024</result_value>
                            <result_value_date dtype="datetime">7/31/2024 13:20</result_value_date>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">4</seq_in_execution>
                            <seq_num_in_group dtype="string">4</seq_num_in_group>
                        </row>
                        <row search_key="surrogate_result_id;-2135633995" number="5">
                            <surrogate_result_id dtype="string">-2135633995</surrogate_result_id>
                            <cl_id dtype="string">289</cl_id>
                            <entry_id dtype="string">1842</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">597</result_value>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">5</seq_in_execution>
                            <seq_num_in_group dtype="string">1</seq_num_in_group>
                        </row>
                        <row search_key="surrogate_result_id;-2135633994" number="6">
                            <surrogate_result_id dtype="string">-2135633994</surrogate_result_id>
                            <cl_id dtype="string">289</cl_id>
                            <entry_id dtype="string">1843</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">598</result_value>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">6</seq_in_execution>
                            <seq_num_in_group dtype="string">2</seq_num_in_group>
                        </row>
                        <row search_key="surrogate_result_id;-2135633993" number="7">
                            <surrogate_result_id dtype="string">-2135633993</surrogate_result_id>
                            <cl_id dtype="string">289</cl_id>
                            <entry_id dtype="string">1844</entry_id>
                            <comments dtype="string"></comments>
                            <result_value dtype="string">599</result_value>
                            <result_status dtype="string">P</result_status>
                            <skip_line dtype="string">N</skip_line>
                            <is_from_repeat_section dtype="string">N</is_from_repeat_section>
                            <added_by dtype="string">rgilbert</added_by>
                            <outstanding_action dtype="string">N</outstanding_action>
                            <seq_in_execution dtype="string">7</seq_in_execution>
                            <seq_num_in_group dtype="string">3</seq_num_in_group>
                        </row>
                    </checklist_for_order>
                </action>
            </state>
        </session>
    </root>

    Thanks,
    Reid

    Phil Seifert
    T
    2 people like this
    • Phil Seifert
      Phil Seifert
    • T
      tvg
    T
    Sidekick (Customer)
    Forum|alt.badge.img+7
    • tvg
    • Author
    • Sidekick (Customer)
    • 39 replies
    • July 31, 2024

    Hi Reid,

    thanks a lot for your answer. Very helpful. (as usual 😉)

     

    I normally use the “Audit API” Switch to log and get API’s from inbound data audit. 

    One hint for that tip, which I recognized now: When using this option, it makes a different if I do some actions in backend or in mobile edge.

     

    To explain it: Yesterday I tried to create the API with my own backened account inside backend. (Action was to change an activiy checklist) - but this was not recorded by inbound data audit. (allthough the option is active for my account!)

     

    I tried today same in mobile edge, and then it got logged in inbound data audit. 😎

    Maybe that information also helps also other people, who are wondering why APIs sometimes are not getting logged in inbound data.

     

    Thanks once more time for your help, highly appreciated. 👍

     

    Regards

    Torsten

    Reply


    Terms & ConditionsCookie settings

    Cookie policy

    We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

     
    Cookie settings