Assignments v4

The page is an archive of Assignments. It has been replaced by version 6.

This call has been updated to reflect the 4th version of the API.

The original Assignments call can be found using this link.

The API calls listed below enable a person to view, create, and edit Assignments 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 Assignments


GET Assignments/

Returns a list of all assignments using pagination.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read access to the 'Assignments' view or the 'Timesheet - Time Entry' tool. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Assignments/?version=4
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/?version=4" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)


Example JSON request:
 
        URI: https://api.dovico.com/Assignments/?version=4
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/?version=4" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 

Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>P138</AssignmentID>
                    <ItemID>138</ItemID>
                    <Name>Development Project</Name>
                    <StartDate>2011-05-18</StartDate>
                    <FinishDate>2012-05-18</FinishDate>
                    <EstimatedHours>N/A</EstimatedHours>
                    <Charge>N/A</Charge>
                    <ChargeCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <Wage>N/A</Wage>
                    <WageCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <Prorate>N/A</Prorate>
                    <ETC>N/A</ETC>
                    <Hide>N/A</Hide>
                    <GetAssignmentsURI>https://api.dovico.com/Assignments/P138/?version=4</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Projects/138/?version=4</GetItemURI>
                </Assignment>
                <Assignment>
                    ...
                </Assignment>
            </Assignments>
            <PrevPageURI>https://api.dovico.com/Assignments/?prev=P138&version=4</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Assignments/?next=P150&version=4</NextPageURI>
        </Result>
 

Fields for Result

Assignments (will return one or more Assignment 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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record

Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"P138",
                    "ItemID":"138",
                    "Name":"Development Project",
                    "StartDate":"2011-05-18",
                    "FinishDate":"2012-05-18",
                    "EstimatedHours":"N\/A",
                    "Charge":"N\/A",
                    "ChargeCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Wage":"N\/A",
                    "WageCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Prorate":"N\/A",
                    "ETC":"N\/A",
                    "Hide":"N\/A",
                    "GetAssignmentsURI":"https:\/\/api.dovico.com\/Assignments\/P138\/?version=4",
                    "GetItemURI":"https:\/\/api.dovico.com\/Projects\/138\/?version=4"
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Assignments\/?prev=P138&version=4",
        "NextPageURI":"https:\/\/api.dovico.com\/Assignments\/?next=P150&version=4"
        }
 

Fields

Assignments (will return one or more Assignment 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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Get child assignments of the item specified


GET Assignments/{sAssignID}/

Returns a list of all assignments that are immediately below the requested assignment. Data is returned using pagination.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read access to the 'Assignments' view or Access to the 'Timesheet - Time Entry' tool. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Assignments/{AssignmentID}/?version=4
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/P100/?version=4" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""

Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/{AssignmentID}/?version=4
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/P100/?version=4" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""

Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>T8423</AssignmentID>
                    <ItemID>100</ItemID>
                    <Name>Bank Holiday</Name>
                    <StartDate>N/A</StartDate>
                    <FinishDate>N/A</FinishDate>
                    <EstimatedHours>N/A</EstimatedHours>
                    <Charge>N/A</Charge>
                    <ChargeCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <Wage>N/A</Wage>
                    <WageCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <Prorate>N/A</Prorate>
                    <ETC>N/A</ETC>
                    <Hide>N/A</Hide>
                    <GetAssignmentsURI>https://api.dovico.com/Assignments/T8423/?version=4</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Tasks/100/?version=4</GetItemURI>
                </Assignment>
                <Assignment>
                    ...
                </Assignment>
            </Assignments>
            <PrevPageURI>https://api.dovico.com/Assignments/P138/?prev=T8423&version=4</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Assignments/P138/?next=T8479&version=4</NextPageURI>
        </Result>
 


Fields for Result

Assignments (will return zero nodes if the specified assignment has no child assignments. Will return one or more nodes for each first-level assignment child of the item specified.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record


Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"T8423",
                    "ItemID":"100",
                    "Name":"Bank Holiday",
                    "StartDate":"N\/A",
                    "FinishDate":"N\/A",
                    "EstimatedHours":"N\/A",
                    "Charge":"N\/A",
                    "ChargeCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Wage":"N\/A",
                    "WageCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Prorate":"N\/A",
                    "ETC":"N\/A",
                    "Hide":"N\/A",
                    "GetAssignmentsURI":"https:\/\/api.dovico.com\/Assignments\/T8423\/?version=4",
                    "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/100\/?version=4"
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Assignments\/P138\/?prev=T8423&version=4",
        "NextPageURI":"https:\/\/api.dovico.com\/Assignments\/P138\/?next=T8479&version=4"
        }
 
 


Fields

Assignments (will return zero objects if the specified assignment has no child assignments. Will return one or more objects for each first-level assignment child of the item specified.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Get the assignments for the Project requested


GET Assignments/Project/{sProjectID}/

Returns a list of all assignments, for the requested Project, using pagination.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read access to the 'Assignments' view or Access to the 'Timesheet - Time Entry' tool. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Assignments/Project/{ProjectID}/?version=4
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/Project/138/?version=4" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""

Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/Project/{ProjectID}/?version=4
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/Project/138/?version=4" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""

Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>P138</AssignmentID>
                    <ItemID>138</ItemID>
                    <Name>Development Project</Name>
                    <StartDate>2011-05-18</StartDate>
                    <FinishDate>2012-05-18</FinishDate>
                    <EstimatedHours>N/A</EstimatedHours>
                    <Charge>N/A</Charge>
                    <ChargeCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <Wage>N/A</Wage>
                    <WageCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <Prorate>N/A</Prorate>
                    <ETC>N/A</ETC>
                    <Hide>N/A</Hide>
                    <GetAssignmentsURI>https://api.dovico.com/Assignments/P138/?version=4</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Projects/138/?version=4</GetItemURI>
                </Assignment>
            </Assignments>
            <PrevPageURI>https://api.dovico.com/Assignments/Project/138/?prev=P138&version=4</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Assignments/Project/138/?next=P138&version=4</NextPageURI>
        </Result>
 

Fields for Result

Assignments (will return zero Assignment nodes if the specified project does not exist. Will return one Assignment node if the project does exist.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record

Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"P138",
                    "ItemID":"138",
                    "Name":"Development Project",
                    "StartDate":"2011-05-18",
                    "FinishDate":"2012-05-18",
                    "EstimatedHours":"N\/A",
                    "Charge":"N\/A",
                    "ChargeCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Wage":"N\/A",
                    "WageCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Prorate":"N\/A",
                    "ETC":"N\/A",
                    "Hide":"N\/A",
                    "GetAssignmentsURI":"https:\/\/api.dovico.com\/Assignments\/P138\/?version=4",
                    "GetItemURI":"https:\/\/api.dovico.com\/Projects\/138\/?version=4"
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Assignments\/Project\/138\/?prev=P138&version=4",
        "NextPageURI":"https:\/\/api.dovico.com\/Assignments\/Project\/138\/?next=P138&version=4"
        }
 


Fields

Assignments (will return zero Assignment objects if the specified project does not exist. Will return one Assignment object if the project does exist.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Get all assignments that have the requested Task assigned


GET Assignments/Task/{sTaskID}/

Returns a list of all assignments, that have the requested Task assigned, using pagination.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read access to the 'Assignments' view or Access to the 'Timesheet - Time Entry' tool. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Assignments/Task/{TaskID}/?version=4
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/Task/100/?version=4" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/Task/{TaskID}/?version=4
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/Task/100/?version=4" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""

Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>P138</AssignmentID>
                    <ItemID>138</ItemID>
                    <Name>Development Project</Name>
                    <StartDate>2011-05-18</StartDate>
                    <FinishDate>2012-05-18</FinishDate>
                    <EstimatedHours>N/A</EstimatedHours>
                    <Charge>N/A</Charge>
                    <ChargeCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <Wage>N/A</Wage>
                    <WageCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <Prorate>N/A</Prorate>
                    <ETC>N/A</ETC>
                    <Hide>N/A</Hide>
                    <GetAssignmentsURI>https://api.dovico.com/Assignments/P138~T100/?version=4</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Projects/138/?version=4</GetItemURI>
                </Assignment>
                <Assignment>
                    ...
                </Assignment>
            </Assignments>
            <PrevPageURI>https://api.dovico.com/Assignments/Task/100/?prev=P138&version=4</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Assignments/Task/100/?next=P150&version=4</NextPageURI>
        </Result>
 


Fields for Result

Assignments (will return zero Assignment nodes if the specified task is not assigned to anything. Will return one Assignment node for each project the task is assigned to.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record

Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"P138",
                    "ItemID":"138",
                    "Name":"Development Project",
                    "StartDate":"2011-05-18",
                    "FinishDate":"2012-05-18",
                    "EstimatedHours":"N\/A",
                    "Charge":"N\/A",
                    "ChargeCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Wage":"N\/A",
                    "WageCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Prorate":"N\/A",
                    "ETC":"N\/A",
                    "Hide":"N\/A",
                    "GetAssignmentsURI":"https:\/\/api.dovico.com\/Assignments\/P138~T100\/?version=4",
                    "GetItemURI":"https:\/\/api.dovico.com\/Projects\/138\/?version=4"
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Assignments\/Task\/100\/?prev=P138&version=4",
        "NextPageURI":"https:\/\/api.dovico.com\/Assignments\/Task\/100\/?next=P150&version=4"
        }
 

Fields

Assignments (will return zero Assignment objects if the specified task is not assigned to anything. Will return one Assignment object for each project the task is assigned to.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Get all assignments that have the requested Employee assigned


GET Assignments/Employee/{sEmployeeID}/

Returns a list of all assignments, that have the requested Employee assigned, using pagination.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read access to the 'Assignments' view or Access to the 'Timesheet - Time Entry' tool. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Assignments/Employee/{EmployeeID}/?version=4
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/Employee/100/?version=4" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/Employee/{EmployeeID}/?version=4
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/Employee/100/?version=4" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
Fields for the URI
ForTimeEntry (optional query string - 'T' or 'F' to indicate if the call should return only the logged in user's assignments based on what a 'Time and Expense Entry only' user would see)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>P138</AssignmentID>
                    <ItemID>138</ItemID>
                    <Name>Development Project</Name>
                    <StartDate>2011-05-18</StartDate>
                    <FinishDate>2012-05-18</FinishDate>
                    <EstimatedHours>N/A</EstimatedHours>
                    <Charge>N/A</Charge>
                    <ChargeCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <Wage>N/A</Wage>
                    <WageCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <Prorate>N/A</Prorate>
                    <ETC>N/A</ETC>
                    <Hide>N/A</Hide>
                    <GetAssignmentsURI>https://api.dovico.com/Assignments/P138~E100/?version=4</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Projects/138/?version=4</GetItemURI>
                </Assignment>
                <Assignment>
                    ...
                </Assignment>
            </Assignments>
            <PrevPageURI>https://api.dovico.com/Assignments/Employee/100/?prev=P138&version=4</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Assignments/Employee/100/?next=P150&version=4</NextPageURI>
        </Result>
 


Fields for Result

Assignments (will return zero Assignment nodes if the specified employee is not assigned to anything. Will return one Assignment node for each project the employee is assigned to.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record

Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"P138",
                    "ItemID":"138",
                    "Name":"Development Project",
                    "StartDate":"2011-05-18",
                    "FinishDate":"2012-05-18",
                    "EstimatedHours":"N\/A",
                    "Charge":"N\/A",
                    "ChargeCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Wage":"N\/A",
                    "WageCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Prorate":"N\/A",
                    "ETC":"N\/A",
                    "Hide":"N\/A",
                    "GetAssignmentsURI":"https:\/\/api.dovico.com\/Assignments\/P138~E100\/?version=4",
                    "GetItemURI":"https:\/\/api.dovico.com\/Projects\/138\/?version=4"
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Assignments\/Employee\/100\/?prev=P138&version=4",
        "NextPageURI":"https:\/\/api.dovico.com\/Assignments\/Employee\/100\/?next=P150&version=4"
        }
 


Fields

Assignments (will return zero Assignment objects if the specified employee is not assigned to anything. Will return one Assignment object for each project the employee is assigned to.)
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 Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. e.g. Client, Project, Task Group, Task, or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Client, Project, Task, or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Insert


POST Assignments/

Creates the Assignments specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Assignments view. Data will also be restricted based on limited access settings.
Example XML request:
 
        URI: https://api.dovico.com/Assignments/?version=4
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/?version=4" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Assignments><Project><ProjectID>99</ProjectID><Tasks><Task><TaskID>100</TaskID><Employees><Employee><EmployeeID>100</EmployeeID><StartDate>2000-06-01</StartDate><FinishDate>2012-06-01</FinishDate><EstimatedHours>99</EstimatedHours><ETC>84</ETC><Hide>F</Hide></Employee></Employees></Task></Tasks></Project></Assignments>"
 


Fields for Assignments

*Project (required - at least one Project node is required but more than one can be provided)


Fields for Project

*ProjectID (required - long - the ID of the project that the contained Task/Employee information will be assigned to. The Project ID must exist)
*Tasks (required - at least one Task node is required but more than one can be provided)


Fields for Task

*TaskID (required - long - the ID of the Task to assign to the parent Project. The Task ID must exist)
Employees (optional - if specified, at least one Employee node is required but more than one can be provided)


Fields for Employee

*EmployeeID (required - long - the ID of the Employee to assign to the parent Task. The Employee ID must exist)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before FinishDate)
FinishDate (optional - date string in the format yyyy-MM-dd. FinishDate must be on or after StartDate)
EstimatedHours (optional - double in US English format)
ETC (optional - double in US English format)
Hide (optional - string 'T' or 'F' - a flag that indicates if the Task assignment should be made visible to the Employee assigned to it in the Time Entry tools)


Note that Microsoft Project projects as well as DOVICO Resource Scheduler projects cannot be modified.

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/?version=4
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/?version=4" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ProjectID"":""99"",""Tasks"":[{""TaskID"":""100"",""Employees"":[{""EmployeeID"":""100"",""StartDate"":""2000-06-01"",""FinishDate"":""2012-06-01"",""EstimatedHours"":""99"",""ETC"":""84"",""Hide"":""F""}]}]}]"
 


Fields for Assignments

*An array containing at least one Project object (required)


Fields for Project

*ProjectID (required - long - the ID of the project that the contained Task/Employee information will be assigned to. The Project ID must exist)
*Tasks (required - an array containing at least one Task object)


Fields for Task

*TaskID (required - long - the ID of the Task to assign to the parent Project. The Task ID must exist)
Employees (optional - if specified, an array containing at least one Employee object)


Fields for Employee

*EmployeeID (required - long - the ID of the Employee to assign to the parent Task. The Employee ID must exist)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before FinishDate)
FinishDate (optional - date string in the format yyyy-MM-dd. FinishDate must be on or after StartDate)
EstimatedHours (optional - double in US English format)
ETC (optional - double in US English format)
Hide (optional - string 'T' or 'F' - a flag that indicates if the Task assignment should be made visible to the Employee assigned to it in the Time Entry tools)


Note that Microsoft Project projects as well as DOVICO Resource Scheduler projects cannot be modified.

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>P138</AssignmentID>
                    <ItemID>138</ItemID>
                    <Name>Development Project</Name>
                    <StartDate>2011-05-18</StartDate>
                    <FinishDate>2012-05-18</FinishDate>
                    <EstimatedHours>N/A</EstimatedHours>
                    <Charge>N/A</Charge>
                    <ChargeCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <Wage>N/A</Wage>
                    <WageCurrency>
                        <ID>N/A</ID>
                        <Symbol>N/A</Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <Prorate>N/A</Prorate>
                    <ETC>N/A</ETC>
                    <Hide>N/A</Hide>
                    <GetAssignmentsURI>https://api.dovico.com/Assignments/P138/?version=4</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Projects/138/?version=4</GetItemURI>
                </Assignment>
            </Assignments>
        </Result>
 


Fields for Result

Assignments (Will return one node for each Project assignment POSTed.)


Fields for Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. In this case, the Project ID)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for. In this case, the Project)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record

Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"P138",
                    "ItemID":"138",
                    "Name":"Development Project",
                    "StartDate":"2011-05-18",
                    "FinishDate":"2012-05-18",
                    "EstimatedHours":"N\/A",
                    "Charge":"N\/A",
                    "ChargeCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Wage":"N\/A",
                    "WageCurrency":
                    {
                        "ID":"N\/A",
                        "Symbol":"N\/A",
                        "GetItemURI":"N\/A"
                    },
                    "Prorate":"N\/A",
                    "ETC":"N\/A",
                    "Hide":"N\/A",
                    "GetAssignmentsURI":"https:\/\/api.dovico.com\/Assignments\/P138\/?version=4",
                    "GetItemURI":"https:\/\/api.dovico.com\/Projects\/138\/?version=4"
                }
            ]
        }
 

Fields

Assignments (Will return one object for each Project assignment POSTed.)


Fields for Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for. In this case, the Project ID)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for. In this case, the Project)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record



Update (bulk)


PUT Assignments/

Updates the Assignments specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Assignments view. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Assignments/?version=4
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/?version=4" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Assignments><Assignment><ID>63477</ID><Employee><ETC>84</ETC></Employee></Assignment></Assignments>"
 
Fields for Assignments
*Assignment (required - at least one Assignment node is required but more than one can be provided)


Fields for Assignment
*ID (required - long - the ID of the assignment record to update)
*Employee (required - Employee object)


Fields for Employee
StartDate (optional - string in the format yyyy-MM-dd. StartDate must be on or before FinishDate)
FinishDate (optional - string in the format yyyy-MM-dd. FinishDate must be on or after StartDate)
EstimatedHours (optional - double - US English format)
ETC (optional - double - US English format)
Hide (optional - string - 'T' or 'F')

NOTE: All fields are optional but at least one must be specified

NOTE: - Only Employee-level assignments can be updated.
- Microsoft Project projects as well as DOVICO Resource Scheduler projects cannot be modified.

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/?version=4
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/?version=4" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ID"":""63477"",""Employee"":{""ETC"":""84""}}]"
 
Fields
*An array containing at least one Assignment object (required)

Fields for Assignment
*ID (required - long - the ID of the assignment record to update)
*Employee (required - Employee object)

Fields for Employee
StartDate (optional - string in the format yyyy-MM-dd. StartDate must be on or before FinishDate)
FinishDate (optional - string in the format yyyy-MM-dd. FinishDate must be on or after StartDate)
EstimatedHours (optional - double - US English format)
ETC (optional - double - US English format)
Hide (optional - string - 'T' or 'F')

NOTE: All fields are optional but at least one must be specified

NOTE: - Only Employee-level assignments can be updated.
- Microsoft Project projects as well as DOVICO Resource Scheduler projects cannot be modified.

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>E63477</AssignmentID>
                    <ItemID>100</ItemID>
                    <Name>Smith, Sam</Name>
                    <StartDate>2000-06-01</StartDate>
                    <FinishDate>2012-06-01</FinishDate>
                    <EstimatedHours>99</EstimatedHours>
                    <Charge>50</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=4</GetItemURI>
                    </ChargeCurrency>
                    <Wage>30</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=4</GetItemURI>
                    </WageCurrency>
                    <Prorate>1</Prorate>
                    <ETC>84</ETC>
                    <Hide>F</Hide>
                    <GetAssignmentsURI>N/A</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Employees/100/?version=4</GetItemURI>
                </Assignment>
            </Assignments>
        </Result>

Fields for Result
Assignments (Will return one node for the assignment item that was PUT.)


Fields for Assignment
AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for - the Task or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Task or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


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

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


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

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record
Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"E63477",
                    "ItemID":"100",
                    "Name":"Smith, Sam",
                    "StartDate":"2000-06-01",
                    "FinishDate":"2012-06-01",
                    "EstimatedHours":"99",
                    "Charge":"50",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=4"
                    },
                    "Wage":"30",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=4"
                    },
                    "Prorate":"1",
                    "ETC":"84",
                    "Hide":"F",
                    "GetAssignmentsURI":"N\/A",
                    "GetItemURI":"https:\/\/api.dovico.com\/Employees\/100\/?version=4"
                }
            ]
        }

Fields for Result
Assignments (will return one object for the assignment item that was PUT)


Fields for Assignment
AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for - the Task or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Task or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


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

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


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

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Update


PUT Assignments/{sAssignID}/

Updates the Assignment specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Assignments view. Data will also be restricted based on limited access settings.
Example XML request:
 
        URI: https://api.dovico.com/Assignments/{AssignmentID}/?version=4
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/E63477/?version=4" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Assignment><Employee><ETC>84</ETC></Employee></Assignment>"
 

Fields for Employee

StartDate (optional - string in the format yyyy-MM-dd. StartDate must be on or before FinishDate)
FinishDate (optional - string in the format yyyy-MM-dd. FinishDate must be on or after StartDate)
EstimatedHours (optional - double - US English format)
ETC (optional - double - US English format)
Hide (optional - string - 'T' or 'F')

NOTE: All fields are optional but at least one must be specified

NOTE: - Only Employee-level assignments can be updated.
- Microsoft Project projects as well as DOVICO Resource Scheduler projects cannot be modified.

Example JSON request:
 
        URI: https://api.dovico.com/Assignments/{AssignmentID}/?version=4
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/E63477/?version=4" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{""Employee"":{""ETC"":""84""}}"
 

Fields for Employee

StartDate (optional - string in the format yyyy-MM-dd. StartDate must be on or before FinishDate)
FinishDate (optional - string in the format yyyy-MM-dd. FinishDate must be on or after StartDate)
EstimatedHours (optional - double - US English format)
ETC (optional - double - US English format)
Hide (optional - string - 'T' or 'F')

NOTE: All fields are optional but at least one must be specified

NOTE: - Only Employee-level assignments can be updated.
- Microsoft Project projects as well as DOVICO Resource Scheduler projects cannot be modified.

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Assignments>
                <Assignment>
                    <AssignmentID>E63477</AssignmentID>
                    <ItemID>100</ItemID>
                    <Name>Smith, Sam</Name>
                    <StartDate>2000-06-01</StartDate>
                    <FinishDate>2012-06-01</FinishDate>
                    <EstimatedHours>99</EstimatedHours>
                    <Charge>50</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=4</GetItemURI>
                    </ChargeCurrency>
                    <Wage>30</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=4</GetItemURI>
                    </WageCurrency>
                    <Prorate>1</Prorate>
                    <ETC>84</ETC>
                    <Hide>F</Hide>
                    <GetAssignmentsURI>N/A</GetAssignmentsURI>
                    <GetItemURI>https://api.dovico.com/Employees/100/?version=4</GetItemURI>
                </Assignment>
            </Assignments>
        </Result>
 

Fields for Result

Assignments (Will return one node for the assignment item that was PUT.)


Fields for Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for - the Task or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Task or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record

Example JSON response:
 
        {
        "Assignments":
            [
                {
                    "AssignmentID":"E63477",
                    "ItemID":"100",
                    "Name":"Smith, Sam",
                    "StartDate":"2000-06-01",
                    "FinishDate":"2012-06-01",
                    "EstimatedHours":"99",
                    "Charge":"50",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=4"
                    },
                    "Wage":"30",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=4"
                    },
                    "Prorate":"1",
                    "ETC":"84",
                    "Hide":"F",
                    "GetAssignmentsURI":"N\/A",
                    "GetItemURI":"https:\/\/api.dovico.com\/Employees\/100\/?version=4"
                }
            ]
        }
 

Fields for Result

Assignments (will return one object for the assignment item that was PUT)


Fields for Assignment

AssignmentID (long - the ID of the assignment itself)
ItemID (long - the ID of the item the assignment is for - the Task or Employee)
Name (string)
StartDate (string - in the format yyyy-MM-dd)
FinishDate (string - in the format yyyy-MM-dd)
EstimatedHours (double - US English format)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
Prorate (double - US English format)
ETC (double - US English format)
Hide (string - 'T' or 'F')
GetAssignmentsURI (string - URI to pull the assignments for all items that are children of the current assignment item)
GetItemURI (string - URI to pull information about the item this assignment is for - the Task or Employee)

NOTE: - The first character of the AssignmentID will indicate the type of record returned ('C' for Client, 'P' for Project, 'G' for Task Group, 'T' for Task, or 'E' for Employee). The rest of the ID following the prefix character is the ID of the assignment itself when dealing with a Task Group, Task, or Employee item. For Client and Project items, the Assignment ID will match the Item ID.
- The Charge field will be 'N/A', for employee level assignment records, if the logged in user does not have Client Cost security access
- The Wage field will be 'N/A', for employee level assignment records, if the logged in user does not have Company Cost security access
- The ETC value, for employee level assignment records, may hold a -1 which indicates an ETC has not yet been specified. A 0 indicates the item is complete and any value above 0 indicates the number of hours of remaining work for the item.
- For project level assignment records, the StartDate and FinishDate values are the project's start and finish dates.
- For non-employee level assignment records the StartDate, FinishDate, EstimatedHours, Charge, Wage, Prorate, ETC, and Hide fields will hold a value of 'N/A' because for non-employee assignment records, this data does not apply.


Fields for ChargeCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Client Cost security access or if this is a non-employee level assignment record


Fields for WageCurrency

ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID, Symbol, and GetItemURI field set to 'N/A' if the logged in user does not have Company Cost security access or if this is a non-employee level assignment record




Delete


DELETE Assignments/{sAssignID}/

Deletes the Assignment specified as well as any child assignments.

Security Check:
The user must have Software Access set to All and have Delete access to the Assignments view. Data will also be restricted based on limited access settings.
Example XML request:
 
        URI: https://api.dovico.com/Assignments/{AssignmentID}/?version=4
        Method: DELETE
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/E63477/?version=4" --request DELETE -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Assignments/{AssignmentID}/?version=4
        Method: DELETE
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Assignments/E63477/?version=4" --request DELETE -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
[Nothing is returned]
 
Example JSON response:
[Nothing is returned]