Request Information
URI Parameters :
None.
Body Parameters :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
company of the contact |
globally unique identifier | |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_title_id | globally unique identifier | ||
| db_functionbis_id | globally unique identifier | ||
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| notes | string | ||
| phone |
Phone number of the contact |
string |
Max length: 255 |
| mobile |
Mobile number of the contact |
string |
Max length: 255 |
|
|
string |
Max length: 255 |
|
| e_login |
e_login |
string |
Max length: 50 |
| e_servicedesk |
e_servicedesk |
boolean | |
| e_new_password |
new_e_password |
string |
Max length: 50 |
| e_commerce | boolean | ||
| e_document | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| contact_picture | Collection of byte |
Request Formats :
application/json, text/json
{
"id": "dcabf1b3-23a3-4ad0-9677-c7e503d2bd6b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2f10d169-a6ee-48f0-82f5-f17378c55922",
"db_language_id": "7cbcfa7f-3535-48b6-ae56-c4559fc85eb4",
"db_title_id": "67121e0f-0cf6-420e-ab22-e1c29f8fa49b",
"db_functionbis_id": "b5ac0e4c-7914-438f-a910-b538f3f009b3",
"archived": true,
"functions": "sample string 9",
"notes": "sample string 10",
"phone": "sample string 11",
"mobile": "sample string 12",
"email": "sample string 13",
"e_login": "sample string 14",
"e_servicedesk": true,
"e_new_password": "sample string 16",
"e_commerce": true,
"e_document": true,
"modified_dateutc": "2026-01-11T21:01:48.6878108+00:00",
"contact_picture": "QEA="
}
application/xml, text/xml
<contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <company_id>2f10d169-a6ee-48f0-82f5-f17378c55922</company_id> <contact_picture>QEA=</contact_picture> <db_functionbis_id>b5ac0e4c-7914-438f-a910-b538f3f009b3</db_functionbis_id> <db_language_id>7cbcfa7f-3535-48b6-ae56-c4559fc85eb4</db_language_id> <db_title_id>67121e0f-0cf6-420e-ab22-e1c29f8fa49b</db_title_id> <e_commerce>true</e_commerce> <e_document>true</e_document> <e_login>sample string 14</e_login> <e_new_password>sample string 16</e_new_password> <e_servicedesk>true</e_servicedesk> <email>sample string 13</email> <firstname>sample string 2</firstname> <functions>sample string 9</functions> <id>dcabf1b3-23a3-4ad0-9677-c7e503d2bd6b</id> <lastname>sample string 3</lastname> <mobile>sample string 12</mobile> <modified_dateutc>2026-01-11T21:01:48.687Z</modified_dateutc> <notes>sample string 10</notes> <phone>sample string 11</phone> </contact>
Response Information
Resource Description :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
company of the contact |
globally unique identifier | |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_title_id | globally unique identifier | ||
| db_functionbis_id | globally unique identifier | ||
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| notes | string | ||
| phone |
Phone number of the contact |
string |
Max length: 255 |
| mobile |
Mobile number of the contact |
string |
Max length: 255 |
|
|
string |
Max length: 255 |
|
| e_login |
e_login |
string |
Max length: 50 |
| e_servicedesk |
e_servicedesk |
boolean | |
| e_new_password |
new_e_password |
string |
Max length: 50 |
| e_commerce | boolean | ||
| e_document | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| contact_picture | Collection of byte |
Response Formats
application/json, text/json
{
"id": "89cc5b75-b9a7-4fee-bd8e-2db575b4b50f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8202670f-92ba-403b-b41b-3800389813cb",
"db_language_id": "62329e2a-3d07-4a1d-b7ec-006eecd098fe",
"db_title_id": "7961eedb-dd7f-4e77-aee2-a523fce552e2",
"db_functionbis_id": "dcb0a139-c179-4870-a5a7-d8ef7563ab62",
"archived": true,
"functions": "sample string 9",
"notes": "sample string 10",
"phone": "sample string 11",
"mobile": "sample string 12",
"email": "sample string 13",
"e_login": "sample string 14",
"e_servicedesk": true,
"e_new_password": "sample string 16",
"e_commerce": true,
"e_document": true,
"modified_dateutc": "2026-01-11T21:01:48.7245191+00:00",
"contact_picture": "QEA="
}
application/xml, text/xml
<contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <company_id>8202670f-92ba-403b-b41b-3800389813cb</company_id> <contact_picture>QEA=</contact_picture> <db_functionbis_id>dcb0a139-c179-4870-a5a7-d8ef7563ab62</db_functionbis_id> <db_language_id>62329e2a-3d07-4a1d-b7ec-006eecd098fe</db_language_id> <db_title_id>7961eedb-dd7f-4e77-aee2-a523fce552e2</db_title_id> <e_commerce>true</e_commerce> <e_document>true</e_document> <e_login>sample string 14</e_login> <e_new_password>sample string 16</e_new_password> <e_servicedesk>true</e_servicedesk> <email>sample string 13</email> <firstname>sample string 2</firstname> <functions>sample string 9</functions> <id>89cc5b75-b9a7-4fee-bd8e-2db575b4b50f</id> <lastname>sample string 3</lastname> <mobile>sample string 12</mobile> <modified_dateutc>2026-01-11T21:01:48.724Z</modified_dateutc> <notes>sample string 10</notes> <phone>sample string 11</phone> </contact>