IMPORTANT NOTE ABOUT THIS API DOCUMENTATION:

The API documentation has been moved to http://www.dovico.com/developer/API_doc/index.htm.


The Content of this wiki will be deleted on Friday July 20th, 2018.

PLEASE UPDATE YOUR BOOKMARKS AS REQUIRED

Task Templates


Important note about API versions

If you are using Dovico Timesheet version 13 or below, you should use API version 5. If using version 14, use API version 6.


The API calls listed below enable a person to view, create, and edit Task Templates that they have been given security access to within DOVICO Timesheet or DOVICO Planning and Timesheet.

Examples are provided using cURL.cURL is a 3rd party tool used for transferring data with URL syntax.


Get all Task Templates


GET TaskTemplates/

Returns a list of all Task Templates using pagination. Note: The $filter query string can optionally be included with this request.

Security Check:
The user must have Software Access set to All and have Read access to the Task Templates view.

Example XML request:
 
        URI: https://api.dovico.com/TaskTemplates/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TaskTemplates/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TaskTemplates/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TaskTemplates/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <TaskTemplates>
                <TaskTemplate>
                    <ID>426</ID>
                    <Name>Data Entry</Name>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Billable>F</Billable>
                    <BillingRate>0.00</BillingRate>
                    <BillingRateCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </BillingRateCurrency>
                    <CustomFields>
                        <CustomField>
                            <ID>1924</ID>
                            <TemplateID>172</TemplateID>
                            <Name>Job Number</Name>
                            <Values>
                                <Value></Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/172/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TaskTemplate>
                <TaskTemplate>
                    ...
                </TaskTemplate>
            </TaskTemplates>
            <PrevPageURI>https://api.dovico.com/TaskTemplates/?prev=1754&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TaskTemplates/?next=1794&version=6</NextPageURI>
        </Result>
Fields for Result
TaskTemplates (will return zero or more TaskTemplate nodes)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for TaskTemplate
ID (long)
Name (string)
Description (string)
ForceDescription (string - 'T' or 'F')
TaskGroup (node containing information about the Task Group associated with this task)
Billable (string - 'T' or 'F')
BillingRate (double - US English format)
BillingRateCurrency (node containing information about the Currency this task template has selected)
CustomFields (will return zero or more CustomField nodes)



Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for BillingRateCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the currency)


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "TaskTemplates":
            [
                {
                    "ID":"1754",
                    "Name":"System Testing",
                    "Description":"",
                    "ForceDescription":"F",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Billable":"F",
                    "BillingRate":"0.00",
                    "BillingRateCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "CustomFields":
                    [
                        {
                            "ID":"1924",
                            "TemplateID":"172",
                            "Name":"Job Number",
                            "Values":
                            [
                                ""
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/172\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TaskTemplates\/?prev=1754&version=6",
        "NextPageURI":"https:\/\/api.dovico.com\/TaskTemplates\/?next=1794&version=6"
        }
Fields
TaskTemplates (will return zero or more TaskTemplate objects)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for TaskTemplate
ID (long)
Name (string)
Description (string)
ForceDescription (string - 'T' or 'F')
TaskGroup (object containing information about the Task Group associated with this task template)
Billable (string - 'T' or 'F')
BillingRate (double - US English format)
BillingRateCurrency (object containing information about the Currency this task template has selected)
CustomFields (will return zero or more CustomField objects)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for BillingRateCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the currency)


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)






Get a Task Template


GET TaskTemplates/{sTaskTemplateID}/

Returns the Task Template requested.

Security Check:
The user must have Software Access set to All and have Read access to the Task Templates view.

Example XML request:
 
        URI: https://api.dovico.com/TaskTemplates/{TaskTemplateID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TaskTemplates/1754/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TaskTemplates/{TaskTemplateID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TaskTemplates/1754/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <TaskTemplates>
                <TaskTemplate>
                    <ID>426</ID>
                    <Name>Data Entry</Name>
                    <Description></Description>
                    <ForceDescription>F</ForceDescription>
                    <TaskGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </TaskGroup>
                    <Billable>F</Billable>
                    <BillingRate>0.00</BillingRate>
                    <BillingRateCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </BillingRateCurrency>
                    <CustomFields>
                        <CustomField>
                            <ID>1924</ID>
                            <TemplateID>172</TemplateID>
                            <Name>Job Number</Name>
                            <Values>
                                <Value></Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/172/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TaskTemplate>
                <TaskTemplate>
                    ...
                </TaskTemplate>
            </TaskTemplates>
        </Result>
Fields for Result
TaskTemplates (will return zero TaskTemplate nodes if the requested item does not exist. Will return one TaskTemplate node if the requested item does exist. In the case of a POST, will return one TaskTemplate node for each TaskTemplate item POSTed.)


Fields for TaskTemplate
ID (long)
Name (string)
Description (string)
ForceDescription (string - 'T' or 'F')
TaskGroup (node containing information about the Task Group associated with this task)
Billable (string - 'T' or 'F')
BillingRate (double - US English format)
BillingRateCurrency (node containing information about the Currency this task template has selected)
CustomFields (will return zero or more CustomField nodes)



Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for BillingRateCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the currency)


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "TaskTemplates":
            [
                {
                    "ID":"1754",
                    "Name":"System Testing",
                    "Description":"",
                    "ForceDescription":"F",
                    "TaskGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Billable":"F",
                    "BillingRate":"0.00",
                    "BillingRateCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "CustomFields":
                    [
                        {
                            "ID":"1924",
                            "TemplateID":"172",
                            "Name":"Job Number",
                            "Values":
                            [
                                ""
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/172\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

Fields
TaskTemplates (will return zero TaskTemplate objects if the requested item does not exist. Will return one TaskTemplate object if the requested item does exist. In the case of a POST, will return one TaskTemplate object for each TaskTemplate item POSTed.)


Fields for TaskTemplate
ID (long)
Name (string)
Description (string)
ForceDescription (string - 'T' or 'F')
TaskGroup (object containing information about the Task Group associated with this task template)
Billable (string - 'T' or 'F')
BillingRate (double - US English format)
BillingRateCurrency (object containing information about the Currency this task template has selected)
CustomFields (will return zero or more CustomField objects)


Fields for TaskGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Task Group)

NOTE: The ID will be 0 if the task has no task group specified. The URI will be 'N/A'.


Fields for BillingRateCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the currency)


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)