Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| keyword | string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
db_address| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier | |
| company_id |
Foreign key to the company on which belongs this address |
globally unique identifier | |
| db_address_type_id |
Foreign key to the db_address_type |
globally unique identifier | |
| db_address_type_is_default |
To know if the address type of this address is the default address type for a company |
boolean | |
| name |
Name of the address |
string | |
| street |
Street |
string | |
| street_number |
Street number. Can be not used |
string | |
| zip |
Zip code |
string | |
| city |
City |
string | |
| phone |
Phone number |
string | |
| mobile |
Cell phone number |
string | |
| fax |
Fax number |
string | |
|
Email address |
string | ||
| url |
Url |
string | |
| street2 |
Second street value (if needed) |
string |
Response Formats
application/json, text/json
Sample:
{
"id": "084b3acb-ef2a-4014-897e-6286021a2b14",
"company_id": "1ee7a19e-73b8-435e-8a02-bfefdf499fa3",
"db_address_type_id": "ab9a8df8-ff57-4bfb-9ebf-4f7c853b1d0a",
"db_address_type_is_default": true,
"name": "sample string 5",
"street": "sample string 6",
"street_number": "sample string 7",
"zip": "sample string 8",
"city": "sample string 9",
"phone": "sample string 10",
"mobile": "sample string 11",
"fax": "sample string 12",
"email": "sample string 13",
"url": "sample string 14",
"street2": "sample string 15"
}
application/xml, text/xml
Sample:
<db_address xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Odyssee.ServiceDesk.Api.Models"> <city>sample string 9</city> <company_id>1ee7a19e-73b8-435e-8a02-bfefdf499fa3</company_id> <db_address_type_id>ab9a8df8-ff57-4bfb-9ebf-4f7c853b1d0a</db_address_type_id> <db_address_type_is_default>true</db_address_type_is_default> <email>sample string 13</email> <fax>sample string 12</fax> <id>084b3acb-ef2a-4014-897e-6286021a2b14</id> <mobile>sample string 11</mobile> <name>sample string 5</name> <phone>sample string 10</phone> <street>sample string 6</street> <street2>sample string 15</street2> <street_number>sample string 7</street_number> <url>sample string 14</url> <zip>sample string 8</zip> </db_address>