06. Activities

Interface

It allows you:

• to get the Activities list to use with API Methods;

• to insert a new Activity;

• to update an existing one;

• to delete an Activity (only if was not used!)

Columns that can be used as filters:

• Organization

• Active

• Value

• Name

• IsSummaryLevel

Actions can be done:

• list

• create

• update - Activity name is mandatory

  • delete - Activity name is mandatory

API Methods:

List:

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

Method: GET

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "*",

            "Created": "2014-01-28 14:59:50 +0200",

            "CreatedBy": "Ionut Ursuleanu",

            "Updated": "2014-01-28 14:59:50 +0200",

            "UpdatedBy": "Ionut Ursuleanu",

            "Active": true,

            "Value": "Programare",

            "Name": "Programare",

            "Description": null,

            "IsSummaryLevel": false

        }

    ],

    "totalRows": 1

}

Create:

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

Method: POST

Return: activity name for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "*",

    "Active": true,

    "Value": "new_activity",

    "Name": "New Activity",

    "Description": "some description",

    "IsSummaryLevel": false

}

Update:

URL: https://api.socratecloud.com/webapi/rest/activity/update/{version}?startRow={0}&endRow={100}&accessToken={access_token}&Name={activity_name}

Method: POST

Return: activity name for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "Active": true,

    "Value": "new_activity",

    "Name": "New Activity",

    "Description": "some description (updated)",

    "IsSummaryLevel": false

}

Delete:

URL: https://api.socratecloud.com/webapi/rest/activity/delete/{version}?startRow={0}&endRow={100}&accessToken={access_token}&Name={activity_name}

Method: POST

Return: 'Deleted' for success or error message (start with "ERROR: ")