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": "c375cf3f-0b5e-4e9e-a0c8-4f9162cb3266",
"_parent_id": "722bb79b-e98d-4726-9ad8-5d3afed4eb79",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a2ac06b3-8a7b-4dec-9d98-0d5021f050ea",
"company_id": "70b2d808-a134-4c30-9b3c-2bae3bd9b1a5",
"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": "053d060b-6733-47df-9348-1da097b37bfc",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "588183e2-b97e-4639-85bc-b275c635c4bd",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "17ad690d-e9e0-4bc1-b47e-b82877b166be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c7f65042-7213-4d81-8023-4eb79f3a0201",
"company_code": "sample string 5",
"company": {
"id": "1adba270-e451-43a4-9f95-ae54e5dcc9f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-19T09:01:39.9594711+00:00",
"sales_territory_id": "4b6e056f-ed77-49c5-aeff-7b897e352af4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e8dfabc3-0207-4ec9-9431-3c29b1e29df8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98c3e152-2c7c-4450-8e00-8eb5d8ee7e1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b69cd4e6-4cc2-439d-84ea-7edb547d981d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c493a570-4c87-4e27-9e02-fc128adf81bb",
"db_currency_id": "8dd9a522-9430-4575-86bf-7feb81084c08",
"db_language_id": "f2173fbe-56a0-429a-b9a4-a509d0fc89b7",
"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-04-19T09:01:39.9594711+00:00"
},
"modified_dateutc": "2024-04-19T09:01:39.9594711+00:00"
},
"marketing_segment_id": "4ea96c98-6410-4590-8953-ef376d5bf783",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "31095c72-2d80-4ec2-8ca1-8d91f8b89b2e",
"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": "58e09374-b83e-4068-bb83-dd06c54cddaf",
"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": "5b98c630-9dee-410c-b485-2977958dc32d",
"db_country_code": "sample string 28",
"feelist_id": "ae070841-13f1-4f9b-9132-1a56263a661c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f44c42a5-d09e-4e0a-9b42-0c49dd36ec6d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3c575b30-eb08-4811-923a-8f91f0dd08c6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-19T09:01:39.9594711+00:00",
"db_currency_id": "9fb5ef08-a5ab-44ca-8e5c-7efd154ffb7b",
"db_currency_code": "sample string 10"
},
"company_type_id": "65240f4b-4085-4b41-b1c8-61cce927edaf",
"company_type_name": "sample string 32",
"company_type": {
"id": "fedca5ae-22e2-4e5d-9447-2bcfcbea7189",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90bc4d16-ec9f-4e5d-b77e-dd0868830ae6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "40c91c24-4dd0-4fcd-9696-0b508e47a765",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "469cc2c4-b743-48e6-9a4f-8e38c02280bf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fff4e355-6ea9-45f6-b1ad-5f6aab0ddc34",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0636a427-950c-4b5a-bdb4-b20dd3c642bb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-19T09:01:39.9594711+00:00"
},
"company_sector_id": "daa181c3-a146-4c26-a843-f64f6f3ddd95",
"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": "da85e78f-7e27-4c87-af81-09b7e46e0a94",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14135dd2-f661-49b8-8167-40fa5e06f2aa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "70006034-16cd-4752-b21c-f06e6c3fa9e0",
"account_manager_user_code": "sample string 56",
"company_status_id": "32565dd1-777a-4314-b309-6e4e38880c24",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-19T09:01:39.9594711+00:00",
"id2": 60
},
"db_language_id": "4cf63b9e-ecd8-4fcc-8724-61bfad448e3e",
"db_language_code": "sample string 7",
"db_title_id": "d414416c-0e52-425a-a1ed-cfcd7ca602f1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-19T09:01:39.9594711+00:00",
"create_date": "2024-04-19T09:01:39.9594711+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-04-19T09:01:39.9594711+00:00"
},
"modified_dateutc": "2024-04-19T09:01:39.9594711+00:00",
"id2": 22
}