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
locationName | 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
{ "id": "8be7d515-8ff9-43e8-a8ed-da891b9932d0", "_parent_id": "b538f3db-d8c6-4eca-8414-e7b871a0a51f", "_parent_reference_back_office": "sample string 3", "project_status_id": "8b2c04bf-d42e-44e0-8ebc-9035ef2f4795", "company_id": "bcbd9773-74a7-4655-9d05-ac2228011eeb", "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": "512a76dd-4000-4d29-8e0d-f7b00e4e5e4f", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "1799a5ea-3087-4aac-a82d-d448e10f6bff", "contact_reference_back_office": "sample string 20", "contact": { "id": "376b4a05-724a-40f3-bda5-7dee49f47b25", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "bc3e92d7-5ef1-4288-b150-dc0efead1df2", "company_code": "sample string 5", "company": { "id": "a43337db-1abc-4ed9-a1c1-170092f50d24", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-03-26T17:51:09.9269882+00:00", "sales_territory_id": "b336718e-c3f2-4f9c-98a7-98d7bafbdb5d", "sales_territory_code": "sample string 9", "sales_territory": { "id": "a9336fc0-3233-47eb-8f89-af73ac014edb", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "66d1d43d-5d3c-489c-9ff2-88233c499404", "sales_organization_code": "sample string 5", "sales_organization": { "id": "4fcc07dd-52b3-47ba-8bc1-5adb4424e0e7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c9c8635c-1002-4b5b-b11d-567fc13bf9c4", "db_currency_id": "12d3af24-2970-4efd-8eae-c1f4273f1213", "db_language_id": "ac4a3ab9-c0c6-4e62-b016-871eaf77370d", "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-03-26T17:51:09.9269882+00:00" }, "modified_dateutc": "2024-03-26T17:51:09.9269882+00:00" }, "marketing_segment_id": "428af758-7a7b-405b-b54b-45f378507c5f", "marketing_segment_code": "sample string 11", "sales_organization_id": "5efdfe3c-f15f-4c78-a124-83d3dd9b7720", "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": "453c8d1e-e522-42c6-8e15-6201a8a670c4", "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": "6dbcf61a-50e1-42ff-b3ed-0f4146e073b7", "db_country_code": "sample string 28", "feelist_id": "1ee0ccd6-bbb7-4f32-a58b-a11900cd0de1", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "bf7649a7-bdc1-4fa7-909f-1de657acc848", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "00be5106-4fe2-49cf-adcc-03a2233ada8d", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-03-26T17:51:09.9269882+00:00", "db_currency_id": "f12aec60-672d-4862-959b-c79c5810d5e9", "db_currency_code": "sample string 10" }, "company_type_id": "4c5c91b5-49b5-4b71-8ee2-491cd0f10451", "company_type_name": "sample string 32", "company_type": { "id": "feba1c9f-1530-4652-a32b-79ffd577e484", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "91c69ec0-cbab-4a26-a516-0fa236b7de1d", "sales_organization_code": "sample string 5" }, "db_language_id": "926d7177-3028-4775-957f-1d354d148b2a", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "989c5d9d-e4af-41cd-a48f-d567ff73ec27", "article_price_label_code": "sample string 37", "db_payment_method_id": "22eac108-20e8-4fa3-8e42-2c1f5f4318dc", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "61331fcb-8a3e-4570-8077-f8ce083dd66c", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-03-26T17:51:09.9269882+00:00" }, "company_sector_id": "7954eeb4-0ef3-48cc-81d6-8e5bf59b3164", "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": "d9356bfa-d973-465b-95a6-f13bfaa1ec5e", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "800ecc9b-c336-4382-ad1f-893a474ae146", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "f61a52c3-0151-4a3d-ad11-c257459548e3", "account_manager_user_code": "sample string 56", "company_status_id": "077adb39-dbca-41e0-95ed-9aa19d5cc221", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-03-26T17:51:09.9269882+00:00", "id2": 60 }, "db_language_id": "c7dfae7f-9043-414c-ba99-162486723362", "db_language_code": "sample string 7", "db_title_id": "303a9fd2-f681-40fc-ad2f-8ee5a4df67c4", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-03-26T17:51:09.9269882+00:00", "create_date": "2024-03-26T17:51:09.9269882+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-03-26T17:51:09.9269882+00:00" }, "modified_dateutc": "2024-03-26T17:51:09.9269882+00:00", "id2": 22 }