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": "74023df8-9deb-4dde-8484-48c092c799a0", "_parent_id": "434a34de-80a9-4afa-b069-802f98530531", "_parent_reference_back_office": "sample string 3", "project_status_id": "1d4dfe54-11c9-4285-8c3f-861a09d80136", "company_id": "f48c2d6c-46db-400f-a782-50cf6279b39b", "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": "2a8a2810-f0fc-4316-9d8f-455683e62f0b", "db_country_code": "sample string 17", "street2": "sample string 18", "latitude_decimal": 1.0, "longitude_decimal": 1.0, "contact_id": "fcbd1753-145e-40db-b215-b4f0135efec1", "contact_reference_back_office": "sample string 20", "contact": { "id": "70b36af0-2d8f-44b5-a3f1-4eaf89bfec3e", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "8ec3086c-eb4d-4dee-a4ca-5d0e6d71d65e", "company_code": "sample string 5", "company": { "id": "2911249c-53e0-4519-9b62-ac1e667dd084", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2023-03-30T21:39:51.2830196+00:00", "sales_territory_id": "ae791cb1-8988-432a-b3b0-e7afc1829d10", "sales_territory_code": "sample string 9", "sales_territory": { "id": "4448a686-5dbb-4021-8889-a44c74b726d5", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "466ace6f-961f-4bed-aea8-3e1293eed850", "sales_organization_code": "sample string 5", "sales_organization": { "id": "907cd088-49f3-486b-b3bd-dbb653114612", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bbd577d6-8963-4323-907f-c100da1ffe53", "db_currency_id": "076818b8-ae03-43c2-8d79-553aaa8929f5", "db_language_id": "2811d0ee-462d-4c6f-af60-afaf749c1605", "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-30T21:39:51.2830196+00:00" }, "modified_dateutc": "2023-03-30T21:39:51.2830196+00:00" }, "marketing_segment_id": "5761b22a-c056-4142-9b50-05a247c82932", "marketing_segment_code": "sample string 11", "sales_organization_id": "903529c5-fa7d-47e5-a238-87ae54075430", "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": "dba4a141-77cb-4dce-b93a-d3c566e5c2b1", "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": "75a366a2-f1ad-4973-a916-24e66ad9de66", "db_country_code": "sample string 28", "feelist_id": "9715ac90-d607-4086-8cc7-ce0b22d005a5", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "3d7ff26d-a070-460f-af53-b41c67a9082b", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "46b548da-5afc-4bc7-93a6-f34a8ddd368a", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2023-03-30T21:39:51.2986479+00:00" }, "company_type_id": "c01ca0ea-0d9c-48dd-8bee-2096c2a9778b", "company_type_name": "sample string 32", "company_type": { "id": "29df3364-9811-43f8-a92b-53643b603fb4", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "91e6e20d-c1d2-4035-b34b-d7ae493a8ad9", "sales_organization_code": "sample string 5" }, "db_language_id": "8a890be7-c7fa-4d28-878c-274607ab8245", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "4be5111e-be50-4bab-ae41-592fc33d940f", "article_price_label_code": "sample string 37", "db_payment_method_id": "e32273dd-ccf6-4c3a-8375-122158863964", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "f5e5fd5c-11ed-470d-8170-a326aaffe927", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2023-03-30T21:39:51.2986479+00:00" }, "company_sector_id": "b7661539-831b-43a1-a950-0b8afc0054f9", "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": "75804506-dda6-43d5-aaa7-aae87b87c43a", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "67d9293f-7f1f-47d2-bdac-683cba355820", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "299d79c8-77a9-4a5a-98d2-7e92e8b90ef9", "account_manager_user_code": "sample string 56", "company_status_id": "ed319c39-e430-4eb0-ad22-4a590fe12b81", "invoice_email_to": "sample string 58", "modified_dateutc": "2023-03-30T21:39:51.2986479+00:00", "id2": 60 }, "db_language_id": "01e2e9e8-42fe-4816-bf16-cf7e91041711", "db_language_code": "sample string 7", "db_title_id": "9edba43a-3fd8-4419-8f64-8504ce72d06d", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2023-03-30T21:39:51.2986479+00:00", "create_date": "2023-03-30T21:39:51.2986479+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-30T21:39:51.2986479+00:00" }, "modified_dateutc": "2023-03-30T21:39:51.2986479+00:00", "id2": 22 }