GET v1/Companies({CompanyId})/Locations

This Call gets Location Details from the Company Tree

Information:

Base URL:

https://api.covasoft.net/entitymanager

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	Company Id from your onboarding package	integer	Required

Body Parameters

None.

Response Information

Resource Description

Location Details from the Company Tree

Collection of CompanyLocationDetailsReturn

Name	Type	Additional information
LocationStatus	string	None.
LocationType	Object	None.
LocationSubType	Object	None.
Address	Address	None.
Contacts	Collection of Object	None.
StorePhoneNumbers	Collection of StorePhoneNumber	None.
Area	Object	None.
StoreHours	StoreHours	None.
Geography	Object	None.
TimeZone	TimeZone	None.
Id	integer	None.
Name	string	None.
DisplayName	string	None.
Description	string	None.
Roles	Collection of Role	None.
Role	string	None.
SortName	string	None.
Attributes	Object	None.
Relationships	Collection of Relationship	None.
Version	integer	None.
CreatedUtc	date	None.
LastModifiedUtc	date	None.
CorrelationId	Object	None.
ClientEntityId	Object	None.
TypeId	integer	None.
Logo	Object	None.
Website	Object	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LocationStatus": "sample string 1",
    "LocationType": {},
    "LocationSubType": {},
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "2cb3e556-5061-46ac-b290-70f3ea321401",
      "CustomerId": "75ca8a3d-551a-4255-b046-cbfe8c85217a",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    "Contacts": [
      {},
      {}
    ],
    "StorePhoneNumbers": [
      {
        "Description": {},
        "Number": "sample string 2",
        "Extension": {}
      },
      {
        "Description": {},
        "Number": "sample string 2",
        "Extension": {}
      }
    ],
    "Area": {},
    "StoreHours": {
      "Monday": {},
      "Tuesday": {},
      "Wednesday": {},
      "Thursday": {},
      "Friday": {},
      "Saturday": {},
      "Sunday": {}
    },
    "Geography": {},
    "TimeZone": {
      "Id": "sample string 1",
      "DaylightSavingTimeEnabled": true
    },
    "Id": 6,
    "Name": "sample string 7",
    "DisplayName": "sample string 8",
    "Description": "sample string 9",
    "Roles": [
      {
        "Name": "sample string 1"
      },
      {
        "Name": "sample string 1"
      }
    ],
    "Role": "sample string 10",
    "SortName": "sample string 11",
    "Attributes": {},
    "Relationships": [
      {
        "Id": 1,
        "Definition": 2,
        "Source": 3,
        "Destination": 4,
        "CreatedUtc": "2024-11-07T08:57:55.1468638+00:00",
        "Version": 6
      },
      {
        "Id": 1,
        "Definition": 2,
        "Source": 3,
        "Destination": 4,
        "CreatedUtc": "2024-11-07T08:57:55.1468638+00:00",
        "Version": 6
      }
    ],
    "Version": 13,
    "CreatedUtc": "2024-11-07T08:57:55.1468638+00:00",
    "LastModifiedUtc": "2024-11-07T08:57:55.1468638+00:00",
    "CorrelationId": {},
    "ClientEntityId": {},
    "TypeId": 18,
    "Logo": {},
    "Website": {}
  },
  {
    "LocationStatus": "sample string 1",
    "LocationType": {},
    "LocationSubType": {},
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "2cb3e556-5061-46ac-b290-70f3ea321401",
      "CustomerId": "75ca8a3d-551a-4255-b046-cbfe8c85217a",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    "Contacts": [
      {},
      {}
    ],
    "StorePhoneNumbers": [
      {
        "Description": {},
        "Number": "sample string 2",
        "Extension": {}
      },
      {
        "Description": {},
        "Number": "sample string 2",
        "Extension": {}
      }
    ],
    "Area": {},
    "StoreHours": {
      "Monday": {},
      "Tuesday": {},
      "Wednesday": {},
      "Thursday": {},
      "Friday": {},
      "Saturday": {},
      "Sunday": {}
    },
    "Geography": {},
    "TimeZone": {
      "Id": "sample string 1",
      "DaylightSavingTimeEnabled": true
    },
    "Id": 6,
    "Name": "sample string 7",
    "DisplayName": "sample string 8",
    "Description": "sample string 9",
    "Roles": [
      {
        "Name": "sample string 1"
      },
      {
        "Name": "sample string 1"
      }
    ],
    "Role": "sample string 10",
    "SortName": "sample string 11",
    "Attributes": {},
    "Relationships": [
      {
        "Id": 1,
        "Definition": 2,
        "Source": 3,
        "Destination": 4,
        "CreatedUtc": "2024-11-07T08:57:55.1468638+00:00",
        "Version": 6
      },
      {
        "Id": 1,
        "Definition": 2,
        "Source": 3,
        "Destination": 4,
        "CreatedUtc": "2024-11-07T08:57:55.1468638+00:00",
        "Version": 6
      }
    ],
    "Version": 13,
    "CreatedUtc": "2024-11-07T08:57:55.1468638+00:00",
    "LastModifiedUtc": "2024-11-07T08:57:55.1468638+00:00",
    "CorrelationId": {},
    "ClientEntityId": {},
    "TypeId": 18,
    "Logo": {},
    "Website": {}
  }
]