Security Groups



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.


Versions 1 through 6

The API calls listed below enable a person to view Security Groups 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 Security Groups


GET SecurityGroups/

Returns a list of all Security Groups using pagination.

Security Check:
The user must have Software Access set to All and have Read access to the Security Groups view.
Example XML request:
 
        URI: https://api.dovico.com/SecurityGroups/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/SecurityGroups/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/SecurityGroups/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/SecurityGroups/?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">
            <SecurityGroups>
                <SecurityGroup>
                    <ID>95</ID>
                    <Name>Time and Expense Entry</Name>
                    <Description>Internal Security Group - can not be modified or deleted.</Description>
                    <ShowClientCost>F</ShowClientCost>
                    <ShowCompanyCost>F</ShowCompanyCost>
                    <Archive>F</Archive>
                </SecurityGroup>
                <SecurityGroup>
                    ...
                </SecurityGroup>
            </SecurityGroups>
            <PrevPageURI>https://api.dovico.com/SecurityGroups/?prev=95&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/SecurityGroups/?next=145&version=6</NextPageURI>
        </Result>

Fields for Result

SecurityGroups (will return zero or more SecurityGroup 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 SecurityGroup

ID (long)
Name (string)
Description (string)
ShowClientCost (string - 'T' or 'F')
ShowCompanyCost (string - 'T' or 'F')
Archive (string - 'T' or 'F')


Example JSON response:
 
        {
        "SecurityGroups":
            [
                {
                    "ID":"95",
                    "Name":"Time and Expense Entry",
                    "Description":"Internal Security Group - can not be modified or deleted.",
                    "ShowClientCost":"F",
                    "ShowCompanyCost":"F",
                    "Archive":"F"
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/SecurityGroups\/?prev=95&version=6",
        "NextPageURI":"https:\/\/api.dovico.com\/SecurityGroups\/?next=145&version=6"
        }

Fields

SecurityGroups (will return zero or more SecurityGroup 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 SecurityGroup

ID (long)
Name (string)
Description (string)
ShowClientCost (string - 'T' or 'F')
ShowCompanyCost (string - 'T' or 'F')
Archive (string - 'T' or 'F')






Get a Security Group


GET SecurityGroups/{sSecurityGroupID}/

Returns the Security Group requested.

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

Example XML request:
 
        URI: https://api.dovico.com/SecurityGroups/{SecurityGroupID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/SecurityGroups/95/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/SecurityGroups/{SecurityGroupID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/SecurityGroups/95/?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">
            <SecurityGroups>
                <SecurityGroup>
                    <ID>95</ID>
                    <Name>Time and Expense Entry</Name>
                    <Description>Internal Security Group - can not be modified or deleted.</Description>
                    <ShowClientCost>F</ShowClientCost>
                    <ShowCompanyCost>F</ShowCompanyCost>
                    <Archive>F</Archive>
                </SecurityGroup>
            </SecurityGroups>
        </Result>

Fields for Result

SecurityGroups (will return zero or more SecurityGroup nodes)


Fields for SecurityGroup

ID (long)
Name (string)
Description (string)
ShowClientCost (string - 'T' or 'F')
ShowCompanyCost (string - 'T' or 'F')
Archive (string - 'T' or 'F')


Example JSON response:
 
        {
        "SecurityGroups":
            [
                {
                    "ID":"95",
                    "Name":"Time and Expense Entry",
                    "Description":"Internal Security Group - can not be modified or deleted.",
                    "ShowClientCost":"F",
                    "ShowCompanyCost":"F",
                    "Archive":"F"
                }
            ]
        }

Fields

SecurityGroups (will return zero or more SecurityGroup objects)


Fields for SecurityGroup

ID (long)
Name (string)
Description (string)
ShowClientCost (string - 'T' or 'F')
ShowCompanyCost (string - 'T' or 'F')
Archive (string - 'T' or 'F')