11. Tasks

Interface

It allows you:

• to insert new: tasks

• to process (update) existing tasks

• to view tasks

Prerequisites:

In order to use this API Method for PUT there must be accomplished the following requirements in SocrateCloud:

• to have the CRM setup completed:

  • Task Type

  • Business Partner 

  • Business Partner Project 

Columns that can  be used as filters:

• Organization

• TaskNo

• TaskType

• BPartner

• Processed

• SalesRepName

• SalesRepEmail

• DatePromised

• RegionName

• Asset_ID

• SerNo

• ProjectName

• Created

• Updated

• AssetValue

Actions can be done:

• list

• insert

• update

• updateStatus

Task fields (Master Document)

A task has the following structure:

1. Task (master document) which contains data about the task:

   • Task No.

   • Task Type

   • Summary

   • Customer etc

2. Task results (lines to Task, see Task Results)  which contains the actions registered to a specific task

   • Result: action, results description

   • Activity

   • SpentTime

API Method

List:

URL: https://api.socratecloud.com/webapi/rest/task/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2014-09-26 17:22:35+0300",

            "CreatedBy": "AdminTitular",

            "Updated": "2014-09-26 17:22:35+0300",

            "UpdatedBy": "AdminTitular",

            "TaskNo": "1000800",

            "TaskType": "Task",

            "Priority": "Medium",

            "Subject": "Mentenanta IT",

            "Summary": "Upgrade sistem ERP",

            "SalesRep": "AdminTitular",

            "DatePromised": "2014-09-30 00:00:00+0300",

            "SalesRepEmail": "socratecloudtest@gmail.com",

            "Region_ID": null,

            "RegionName": null,

            "Asset_ID": 1004522,

            "SerNo": null,

            "AssetName": null,

            "StartPlan": "2014-09-26 09:00:00+0300",

            "QtyPlaned": 0,

            "BPartner": "Client SRL",

            "BPartnerName": "Client SRL",

"BPartnerContact": null,

            "Project": null,

            "ProjectPhase": null,

            "ProjectSubPhase": null,

            "LastResult":"Test"

            "Processed": false,

            "AssetValue": "Test11.10"

        }

    ],

    "totalRows": 1

}

Create:

URL: https://api.socratecloud.com/webapi/rest/task/create/{version}?accessToken={access_token}

Method: POST

Return: request no for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "TaskType": "Task",

    "Priority": "Medium",

    "Subject": "Test",

    "Summary": "Test",

    "SalesRep": "AdminTitular",

    "DatePromised": "2014-01-09 00:00:00+0200",

    "StartPlan": null,

    "QtyPlaned": 0,

    "BPartner": "Client SRL",

    "Project": null,

    "ProjectPhase": null,

    "ProjectSubPhase": null,

     "Asset_ID": 1004522,

    "AssetValue": "Test11.10"

}

Update:

URL: https://api.socratecloud.com/webapi/rest/task/update/{version}?accessToken={access_token}&TaskNo={task_no}

Method: POST

Return: request no for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "TaskType": "Task",

    "Priority": "Medium",

    "Subject": "Test",

    "Summary": "Test",

    "DatePromised": "2014-01-09 00:00:00+0200",

    "StartPlan": null,

    "QtyPlaned": 0,

    "BPartner": "Client SRL",

    "Project": null,

    "ProjectPhase": null,

    "ProjectSubPhase": null,

    "Processed": true,

    "Asset_ID": 1004522,

    "AssetValue": "Test11.10"

}

UpdateStatus:

URL: https://api.socratecloud.com/webapi/rest/task/updateStatus/{version}?accessToken={access_token}&TaskNo={task_no}

Method: POST

Return: request no for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "TaskNo": "1000800",

    "SalesRep": "AdminTitular",

    "DatePromised": "2014-01-09 00:00:00+0200",

    "BPartner": "Client SRL",

    "Processed": true

}