Retrieves an object of the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| _parent_id |
Reference to a parent location |
globally unique identifier | |
| _parent_reference_back_office |
Embedded entity "location" for parent location using ERP PK when adding/updating location |
string | |
| _parent_location |
Embedded entity "location" for parent location when adding/updating location |
location | |
| project_status_id |
Foreign key to project_status_id |
globally unique identifier | |
| company_id |
The company owner of this location |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating location |
string |
Optionally required : company_id, company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating location |
company |
Optionally required : company_id, company_code or company must be provided |
| name |
Name of the location |
string |
Required Max length: 50 |
| extra_information |
extra_information |
string |
Max length: 255 |
| reference_back_office |
The Id/Ref of the back office for this location. Used by Embedded entity |
string |
Max length: 255 |
| street |
Street |
string |
Max length: 100 |
| street_number |
Street number. |
string |
Max length: 50 |
| zip |
Zip code |
string |
Max length: 50 |
| city |
City |
string |
Max length: 50 |
| phone |
Phone number |
string |
Max length: 50 |
|
Email address |
string |
Max length: 250 |
|
| db_country_id |
Foreign key to table Country |
globally unique identifier | |
| db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
| street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
| latitude_decimal |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude_decimal |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| contact_id |
Foreign key of contact for this location |
globally unique identifier | |
| contact_reference_back_office |
Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office |
string | |
| contact |
Embedded entity "contact" when adding/updating location |
contact | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer |
Response Formats
application/json, text/json
Sample:
{
"id": "8bb88bd1-4160-4ddd-a6d1-f3f2521744d2",
"_parent_id": "aba2f740-60a7-4709-a0e2-3a8fe9e10520",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "372cb0dd-e970-4361-96aa-53ee2a6a58ba",
"company_id": "9c0db93f-1050-4c58-9b1f-1d2c0c7d879d",
"company_code": "sample string 6",
"name": "sample string 7",
"extra_information": "sample string 8",
"reference_back_office": "sample string 9",
"street": "sample string 10",
"street_number": "sample string 11",
"zip": "sample string 12",
"city": "sample string 13",
"phone": "sample string 14",
"email": "sample string 15",
"db_country_id": "285c2922-ee9c-48b2-93b9-a8bbee8b061b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "88368882-0d56-44e7-922c-548585d68cf1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7f4cff29-a1f0-45d6-8c7f-1a3427b91214",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "30c0483f-9ef4-482b-a994-edbe002c024e",
"company_code": "sample string 5",
"company": {
"id": "7c7c065d-551d-4dc7-80ce-3ac8c93939ac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T10:12:43.2787312+00:00",
"sales_territory_id": "26783924-bec0-4608-bf77-5eb57daa6419",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "34bedc7e-190e-47af-b58e-b90bd674d0bf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9212294-ce9a-4faf-b9d6-f46f7e517af4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d2329f1-89a9-44ab-bf0c-b3f45c186d17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4451e33-2087-488c-adbe-9ce3c007b045",
"db_currency_id": "1afd24e8-654b-478c-992c-be679b1ac052",
"db_language_id": "69f2ce2d-9f62-4405-a160-907ce82ceb74",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-11-21T10:12:43.2787312+00:00"
},
"modified_dateutc": "2024-11-21T10:12:43.2787312+00:00"
},
"marketing_segment_id": "909c5b6a-b6f1-4157-a025-902db02c48ad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6014127e-e807-4073-947d-054ec9635653",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "5c3dc743-7849-4c04-9aed-f14ada52440c",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "6fc5f4aa-b2d8-4721-b5f0-22f5e9d4a694",
"db_country_code": "sample string 28",
"feelist_id": "9c3af565-65f1-42a6-988f-d500a772851c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ad0370bc-f588-4a19-84c8-d9c87c5b1e99",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2fcf0223-a435-4136-a951-17dd3bad12d6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T10:12:43.2943579+00:00",
"db_currency_id": "94a46038-a186-4283-a40f-dbed58e2155b",
"db_currency_code": "sample string 10"
},
"company_type_id": "3474c942-da46-4386-835d-e1b1539fb300",
"company_type_name": "sample string 32",
"company_type": {
"id": "5de440cf-012e-427b-afac-73bf75527724",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4eb8a72e-7fae-40b3-b659-4e2564d231b8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ecd9fca0-95b6-4855-af3f-7d0904072a11",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "397bde97-8155-48c6-bc82-fba66d728585",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7a734863-5093-4573-9294-2b749e203251",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c42c9feb-2334-479c-9457-064171bb182c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T10:12:43.2943579+00:00"
},
"company_sector_id": "bc9062d5-be95-4e81-8d23-f28cbb1ed0c8",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "826e2e61-3bb3-480f-a138-1abf1ada9200",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "addcdd90-8e6d-4e47-9c23-7fb153aabb1b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3cb64653-b1d3-4c91-b0fb-11cfeb781d9b",
"account_manager_user_code": "sample string 56",
"company_status_id": "1058a5ec-c41c-433f-9286-c2a72ec8db7c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T10:12:43.2943579+00:00",
"id2": 60
},
"db_language_id": "36774090-3322-4a39-add9-0de80e96c1d1",
"db_language_code": "sample string 7",
"db_title_id": "0febb8c8-d9bd-47e6-bd9b-ce15e01bef0d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T10:12:43.2943579+00:00",
"create_date": "2024-11-21T10:12:43.2943579+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2024-11-21T10:12:43.2943579+00:00"
},
"modified_dateutc": "2024-11-21T10:12:43.2943579+00:00",
"id2": 22
}