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": "c1f0e0ad-ac6c-4dea-b7db-cd54119870b8",
"_parent_id": "8c5db1e7-eeb1-43fc-91a5-069453b49596",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "73410ba1-7e9a-4c0a-a9e2-97abe3934bf7",
"company_id": "39dcf212-afbe-46e7-ada1-2aa7868602a8",
"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": "f4381128-5847-4947-82e5-012102bfd39b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2768869c-4ebf-409e-827d-4f325ab8d330",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e6d9fb54-7c14-44f7-8fc3-832accf34a92",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bbf4d3ac-f8ca-401c-b0db-e8cd38a7e170",
"company_code": "sample string 5",
"company": {
"id": "c74c6b56-a754-41ac-95d5-36b1d796739e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-29T03:36:29.8455543+00:00",
"sales_territory_id": "fc844491-8cec-40c5-8bcb-49d4c5e22d79",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1889e54e-e54d-4219-bfbf-e192c6dcccf0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a779383b-3691-41c7-9fb8-1dc6b9faac4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20878a01-392a-4710-a23e-ccb6810f6fa3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d87437c-fdd2-4b20-ad7c-1751838bfc5a",
"db_currency_id": "841a05da-235b-4ffc-b242-54934783a03e",
"db_language_id": "925517e4-1be4-4884-8e91-79525006c92f",
"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": "2023-03-29T03:36:29.8455543+00:00"
},
"modified_dateutc": "2023-03-29T03:36:29.8455543+00:00"
},
"marketing_segment_id": "84e6add9-30e1-442a-b2aa-64c540b85ecf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b2b02543-0b45-40a4-9b74-a65793dcc3ea",
"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": "f1e562c6-5237-474e-a46d-58576827186c",
"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": "367930df-8a2f-44f1-9bc3-41c016dfdda9",
"db_country_code": "sample string 28",
"feelist_id": "d3f7e960-eb85-4c9f-b11e-685f303c0de7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dff00b2d-3866-45bf-908a-3ccd7a3c1bf3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "372e2b9a-cf7b-481a-9f8c-8b424e917ae7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-29T03:36:29.8455543+00:00"
},
"company_type_id": "1380ba7b-fd81-4163-b73b-db2bdca90bb7",
"company_type_name": "sample string 32",
"company_type": {
"id": "883b893d-b601-427b-bdd0-7930dad81d84",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd516e08-f6b0-4d95-a8b7-c474d2b4f97f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7eb7a7b1-fdf4-479e-b4cf-e7fdee775bb1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "23d3a1c1-f6f8-4a7a-b208-d2d7451822d1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0632d511-224c-4ce2-97cf-cc6a83906843",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "11286067-59f1-406b-b1fb-92df719ecf3b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-29T03:36:29.8455543+00:00"
},
"company_sector_id": "ee99e4a0-f52b-42bb-a02c-547d86dcab06",
"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": "dea8fa7e-b832-4701-8c84-ab37df50e0db",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5c3445a4-589f-445a-bdd2-2ef8c3c2a4e2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2bdce120-d616-4c71-9166-d1a60fdb5321",
"account_manager_user_code": "sample string 56",
"company_status_id": "d877df7d-cd45-4a6d-932c-1a29ef9dddb1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-29T03:36:29.8455543+00:00",
"id2": 60
},
"db_language_id": "5e6d36e6-20c6-42f7-9955-228c8709a293",
"db_language_code": "sample string 7",
"db_title_id": "87d5de7c-5816-42f2-9138-25146733121b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-29T03:36:29.8455543+00:00",
"create_date": "2023-03-29T03:36:29.8455543+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": "2023-03-29T03:36:29.8455543+00:00"
},
"modified_dateutc": "2023-03-29T03:36:29.8455543+00:00",
"id2": 22
}