Clients




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
This call has been updated to reflect the 6th version of the API.

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


GET Clients/

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


Security Check:
The user must have Software Access set to All and have Read access to the Clients view.
Example XML request:
 
        URI: https://api.dovico.com/Clients/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Clients/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/?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">
            <Clients>
                <Client>
                    <ID>660</ID>
                    <Name>Client 1</Name>
                    <Abbreviation>Cli 1-</Abbreviation>
                    <Contact>Sam Smith</Contact>
                    <Email>SamSmith@SmithCo.com</Email>
                    <Region>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Region>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Client>
                <Client>
                    ...
                </Client>
            </Clients>
            <PrevPageURI>https://api.dovico.com/Clients/?prev=660&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Clients/?next=741&version=6</NextPageURI>
        </Result>

Fields for Result
Clients (will return zero or more Client 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 Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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

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


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


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)
Example JSON response:
 
        {
        "Clients":
            [
                {
                    "ID":"660",
                    "Name":"Client 1",
                    "Abbreviation":"Cli 1-",
                    "Contact":"Sam Smith",
                    "Email":"SamSmith@SmithCo.com",
                    "Region":
                        {
                            "ID":"0",
                            "Name":"[None]",
                            "GetItemURI":"N\/A"
                        },
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                        [
                            {
                                "ID":"1631",
                                "TemplateID":"148",
                                "Name":"Date of Birth",
                                "Values":
                                    [
                                        "1967-12-31"
                                    ],
                                "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                            },
                            {
                                ...
                            }
                        ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Clients\/?prev=660&version=6",
        "NextPageURI":"https:\/\/api.dovico.com\/Clients\/?next=741&version=6"
        }
Fields
Clients (will return zero or more Client 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 Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (object containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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

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


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


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



Get a Client


GET Clients/{sClientID}/

Returns the Client requested.

Security Check:
The user must have Software Access set to All and have Read access to the Clients view.
Example XML request:
 
        URI: https://api.dovico.com/Clients/{ClientID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/660/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Clients/{ClientID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/660/?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">
            <Clients>
                <Client>
                    <ID>660</ID>
                    <Name>Client 1</Name>
                    <Abbreviation>Cli 1-</Abbreviation>
                    <Contact>Sam Smith</Contact>
                    <Email>SamSmith@SmithCo.com</Email>
                    <Region>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Region>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Client>
            </Clients>
        </Result>

Fields for Result
Clients (will return zero Client nodes if the requested item does not exist. Will return one Client node if the requested item does exist. In the case of a POST, will return one Client node for each Client item POSTed.)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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

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


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


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)
Example JSON response:
 
        {
        "Clients":
            [
                {
                    "ID":"660",
                    "Name":"Client 1",
                    "Abbreviation":"Cli 1-",
                    "Contact":"Sam Smith",
                    "Email":"SamSmith@SmithCo.com",
                    "Region":
                        {
                            "ID":"0",
                            "Name":"[None]",
                            "GetItemURI":"N\/A"
                        },
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                        [
                            {
                                "ID":"1631",
                                "TemplateID":"148",
                                "Name":"Date of Birth",
                                "Values":
                                    [
                                        "1967-12-31"
                                    ],
                                "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                            },
                            {
                                ...
                            }
                        ]
                }
            ]
        }
Fields
Clients (will return zero Client objects if the requested item does not exist. Will return one Client object if the requested item does exist. In the case of a POST, will return one Client object for each Client item POSTed.)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (object containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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

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


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


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



Insert


POST Clients/

Creates the Clients specified.

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

Example XML request:
 
        URI: https://api.dovico.com/Clients/?version=6
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/?version=6" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Clients><Client><Name>Client 1</Name><Abbreviation>Cli 1-</Abbreviation><Contact>Sam Smith</Contact><Email>SamSmith@SmithCo.com</Email></Client></Clients>"

Fields for Clients
*Client (required - at least one Client node is required but more than one can be provided)


Fields for Client
*Name (required and must be unique - string with a maximum length of 250 characters)
*Abbreviation (required and must be unique - string with a maximum length of 20 characters)
Contact (optional - string with a maximum length of 250 characters)
Email (optional - string with a maximum length of 100 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of encoded XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)

CustomFields (optional - zero or more CustomField nodes)

NOTE: - If XML is provided for the Integrate field, the XML needs to be encoded. For example, < characters need to be replaced with &lt;



Fields for CustomField
*ID (required - long - specify -1 in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)
Example JSON request:
 
        URI: https://api.dovico.com/Clients/?version=6
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/?version=6" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""Name"":""Client 1"",""Abbreviation"":""Cli 1-"",""Contact"":""Sam Smith"",""Email"":""SamSmith@SmithCo.com""}]"


Fields for Clients
*An array containing at least one Client object (required)


Fields for Client
*Name (required and must be unique - string with a maximum length of 250 characters)
*Abbreviation (required and must be unique - string with a maximum length of 20 characters)
Contact (optional - string with a maximum length of 250 characters)
Email (optional - string with a maximum length of 100 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
CustomFields (optional - an array of zero or more CustomField objects)


Fields for CustomField
*ID (required - long - specify -1 in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Clients>
                <Client>
                    <ID>660</ID>
                    <Name>Client 1</Name>
                    <Abbreviation>Cli 1-</Abbreviation>
                    <Contact>Sam Smith</Contact>
                    <Email>SamSmith@SmithCo.com</Email>
                    <Region>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Region>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Client>
            </Clients>
        </Result>

Fields for Result
Clients (will return zero Client nodes if the requested item does not exist. Will return one Client node if the requested item does exist. In the case of a POST, will return one Client node for each Client item POSTed.)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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

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


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

Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)
Example JSON response:
 
        {
        "Clients":
            [
                {
                    "ID":"660",
                    "Name":"Client 1",
                    "Abbreviation":"Cli 1-",
                    "Contact":"Sam Smith",
                    "Email":"SamSmith@SmithCo.com",
                    "Region":
                        {
                            "ID":"0",
                            "Name":"[None]",
                            "GetItemURI":"N\/A"
                        },
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                        [
                            {
                                "ID":"1631",
                                "TemplateID":"148",
                                "Name":"Date of Birth",
                                "Values":
                                    [
                                        "1967-12-31"
                                    ],
                                "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                            },
                            {
                                ...
                            }
                        ]
                }
            ]
        }
 

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


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (object containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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

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


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


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




Update (bulk)


PUT Clients/

Updates the Clients specified.

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

Example XML request:
 
        URI: https://api.dovico.com/Clients/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Clients><Client><ID>660</ID><Email>SamSmith@SmithAndSons.com</Email></Client></Clients>"
 

Fields for Clients
*Client (required - at least one Client node is required but more than one can be provided)


Fields for Client
*ID (required - long - the ID of the client record to update)
Name (optional - must be unique - string with a maximum length of 250 characters)
Abbreviation (optional - must be unique - string with a maximum length of 20 characters)
Contact (optional - string with a maximum length of 250 characters)
Email (optional - string with a maximum length of 100 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of encoded XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)

NOTE: - If XML is provided for the Integrate field, the XML needs to be encoded. For example, < characters need to be replaced with &lt;

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example JSON request:
 
        URI: https://api.dovico.com/Clients/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/?version=6" --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"":""660"",""Email"":""SamSmith@SmithAndSons.com""}]"
 


Fields
*An array containing at least one Client object (required)


Fields for Client
*ID (required - long - the ID of the client record to update)
Name (optional - must be unique - string with a maximum length of 250 characters)
Abbreviation (optional - must be unique - string with a maximum length of 20 characters)
Contact (optional - string with a maximum length of 250 characters)
Email (optional - string with a maximum length of 100 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)


WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.

Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Clients>
                <Client>
                    <ID>660</ID>
                    <Name>Client 1</Name>
                    <Abbreviation>Cli 1-</Abbreviation>
                    <Contact>Sam Smith</Contact>
                    <Email>SamSmith@SmithAndSons.com</Email>
                    <Region>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Region>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Client>
            </Clients>
        </Result>

Fields for Result
Clients (will return one Client node)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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

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

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

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

Example JSON response:
 
        {
        "Clients":
            [
                {
                    "ID":"660",
                    "Name":"Client 1",
                    "Abbreviation":"Cli 1-",
                    "Contact":"Sam Smith",
                    "Email":"SamSmith@SmithAndSons.com",
                    "Region":
                        {
                            "ID":"0",
                            "Name":"[None]",
                            "GetItemURI":"N\/A"
                        },
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                        [
                            {
                                "ID":"1631",
                                "TemplateID":"148",
                                "Name":"Date of Birth",
                                "Values":
                                    [
                                        "1967-12-31"
                                    ],
                                "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                            },
                            {
                                ...
                            }
                        ]
                }
            ]
        }

Fields for Result
Clients (will return one Client object)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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

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

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


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





Update


PUT Clients/{sClientID}/

Updates the Client specified.

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

Example XML request:
 
        URI: https://api.dovico.com/Clients/{ClientID}/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/660/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Client><Email>SamSmith@SmithAndSons.com</Email></Client>"


Fields for Client
Name (optional - must be unique - string with a maximum length of 250 characters)
Abbreviation (optional - must be unique - string with a maximum length of 20 characters)
Contact (optional - string with a maximum length of 250 characters)
Email (optional - string with a maximum length of 100 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of encoded XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)

NOTE: - If XML is provided for the Integrate field, the XML needs to be encoded. For example, < characters need to be replaced with &lt;

All fields are optional but at least one must be specified

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)


Example JSON request:
 
        URI: https://api.dovico.com/Clients/{ClientID}/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Clients/660/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{""Email"":""SamSmith@SmithAndSons.com""}"

Fields for Client
Name (optional - must be unique - string with a maximum length of 250 characters)
Abbreviation (optional - must be unique - string with a maximum length of 20 characters)
Contact (optional - string with a maximum length of 250 characters)
Email (optional - string with a maximum length of 100 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)

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

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Clients>
                <Client>
                    <ID>660</ID>
                    <Name>Client 1</Name>
                    <Abbreviation>Cli 1-</Abbreviation>
                    <Contact>Sam Smith</Contact>
                    <Email>SamSmith@SmithAndSons.com</Email>
                    <Region>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Region>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Client>
            </Clients>
        </Result>

Fields for Result
Clients (will return one Client node)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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

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


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


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)
Example JSON response:
 
        {
        "Clients":
            [
                {
                    "ID":"660",
                    "Name":"Client 1",
                    "Abbreviation":"Cli 1-",
                    "Contact":"Sam Smith",
                    "Email":"SamSmith@SmithAndSons.com",
                    "Region":
                        {
                            "ID":"0",
                            "Name":"[None]",
                            "GetItemURI":"N\/A"
                        },
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                        [
                            {
                                "ID":"1631",
                                "TemplateID":"148",
                                "Name":"Date of Birth",
                                "Values":
                                    [
                                        "1967-12-31"
                                    ],
                                "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                            },
                            {
                                ...
                            }
                        ]
                }
            ]
        }
Fields for Result
Clients (will return one Client object)


Fields for Client
ID (long)
Name (string)
Abbreviation (string)
Contact (string)
Email (string)
Region (node containing information about the Region associated with this client)
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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

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


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


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