GET api/CRMSite

Get Sites

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Sites
NameDescriptionTypeAdditional information
SiteUsers

Collection of RelUserSites

None.

Analyzers

Collection of Analyzers

None.

SiteID

integer

None.

SiteCode

string

Required

String length: inclusive between 0 and 35

SiteName

string

String length: inclusive between 0 and 50

SiteNameAlias

string

None.

Address1

string

Required

String length: inclusive between 0 and 100

Address2

string

String length: inclusive between 0 and 100

City

string

Required

String length: inclusive between 0 and 50

PostalCode

string

String length: inclusive between 0 and 20

State

string

Required

String length: inclusive between 0 and 25

Country

string

Required

String length: inclusive between 0 and 25

TimeZoneName

string

String length: inclusive between 0 and 128

IsEnabled

boolean

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

AreaMapID

integer

None.

IsBenchmark

boolean

None.

CountryID

integer

None.

FacilityID

integer

None.

Facilities

Facilities

None.

FacilityCode

string

None.

AreaMapCode

string

None.

CreatedUserID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "SiteUsers": [
    {
      "Users": {
        "UserSites": [],
        "UserDisciplines": [
          {
            "Disciplines": {
              "DisciplineUsers": [],
              "DisciplineID": 1,
              "DisciplineCode": "sample string 2",
              "DisciplineName": "sample string 3",
              "IsEnabled": true,
              "CreatedUserID": 5
            },
            "RelUserDisciplineID": 1,
            "UserID": 2,
            "DisciplineID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "DisciplineCode": "sample string 6",
            "CreatedUserID": 7
          },
          {
            "Disciplines": {
              "DisciplineUsers": [],
              "DisciplineID": 1,
              "DisciplineCode": "sample string 2",
              "DisciplineName": "sample string 3",
              "IsEnabled": true,
              "CreatedUserID": 5
            },
            "RelUserDisciplineID": 1,
            "UserID": 2,
            "DisciplineID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "DisciplineCode": "sample string 6",
            "CreatedUserID": 7
          }
        ],
        "UserSeries": [
          {
            "Series": {
              "SeriesUsers": [],
              "SeriesID": 1,
              "SeriesCode": "sample string 2",
              "SeriesName": "sample string 3",
              "SeriesAbbreviation": "sample string 4",
              "IsEnabled": true,
              "CreatedUserID": 6
            },
            "RelUserSeriesID": 1,
            "UserID": 2,
            "SeriesID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "SeriesCode": "sample string 6",
            "CreatedUserID": 7
          },
          {
            "Series": {
              "SeriesUsers": [],
              "SeriesID": 1,
              "SeriesCode": "sample string 2",
              "SeriesName": "sample string 3",
              "SeriesAbbreviation": "sample string 4",
              "IsEnabled": true,
              "CreatedUserID": 6
            },
            "RelUserSeriesID": 1,
            "UserID": 2,
            "SeriesID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "SeriesCode": "sample string 6",
            "CreatedUserID": 7
          }
        ],
        "UserID": 1,
        "LanguageID": 2,
        "PackageID": 3,
        "UserName": "sample string 4",
        "Email": "sample string 5",
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "IsAdministrator": true,
        "Title": "sample string 9",
        "PhoneNumber": "sample string 10",
        "IsEnabled": true,
        "EncryptedPassword": "sample string 12",
        "CreatedDateTime": "2018-10-17T14:03:11.8737631+00:00",
        "Picture": "sample string 14",
        "ForgotPassword": true,
        "ProfileRegistered": true,
        "CheckedGuide": true,
        "EmailConfirmed": true,
        "SecurityStamp": "sample string 19",
        "Nickname": "sample string 20",
        "LanguageCode": "sample string 21",
        "PackageCode": "sample string 22",
        "FacilityID": 23,
        "SendAdminEmail": true
      },
      "RelUserSiteID": 1,
      "UserID": 2,
      "SiteID": 3,
      "IsDefault": true,
      "Email": "sample string 5",
      "SiteCode": "sample string 6",
      "CreatedUserID": 7
    },
    {
      "Users": {
        "UserSites": [],
        "UserDisciplines": [
          {
            "Disciplines": {
              "DisciplineUsers": [],
              "DisciplineID": 1,
              "DisciplineCode": "sample string 2",
              "DisciplineName": "sample string 3",
              "IsEnabled": true,
              "CreatedUserID": 5
            },
            "RelUserDisciplineID": 1,
            "UserID": 2,
            "DisciplineID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "DisciplineCode": "sample string 6",
            "CreatedUserID": 7
          },
          {
            "Disciplines": {
              "DisciplineUsers": [],
              "DisciplineID": 1,
              "DisciplineCode": "sample string 2",
              "DisciplineName": "sample string 3",
              "IsEnabled": true,
              "CreatedUserID": 5
            },
            "RelUserDisciplineID": 1,
            "UserID": 2,
            "DisciplineID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "DisciplineCode": "sample string 6",
            "CreatedUserID": 7
          }
        ],
        "UserSeries": [
          {
            "Series": {
              "SeriesUsers": [],
              "SeriesID": 1,
              "SeriesCode": "sample string 2",
              "SeriesName": "sample string 3",
              "SeriesAbbreviation": "sample string 4",
              "IsEnabled": true,
              "CreatedUserID": 6
            },
            "RelUserSeriesID": 1,
            "UserID": 2,
            "SeriesID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "SeriesCode": "sample string 6",
            "CreatedUserID": 7
          },
          {
            "Series": {
              "SeriesUsers": [],
              "SeriesID": 1,
              "SeriesCode": "sample string 2",
              "SeriesName": "sample string 3",
              "SeriesAbbreviation": "sample string 4",
              "IsEnabled": true,
              "CreatedUserID": 6
            },
            "RelUserSeriesID": 1,
            "UserID": 2,
            "SeriesID": 3,
            "IsDefault": true,
            "Email": "sample string 5",
            "SeriesCode": "sample string 6",
            "CreatedUserID": 7
          }
        ],
        "UserID": 1,
        "LanguageID": 2,
        "PackageID": 3,
        "UserName": "sample string 4",
        "Email": "sample string 5",
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "IsAdministrator": true,
        "Title": "sample string 9",
        "PhoneNumber": "sample string 10",
        "IsEnabled": true,
        "EncryptedPassword": "sample string 12",
        "CreatedDateTime": "2018-10-17T14:03:11.8737631+00:00",
        "Picture": "sample string 14",
        "ForgotPassword": true,
        "ProfileRegistered": true,
        "CheckedGuide": true,
        "EmailConfirmed": true,
        "SecurityStamp": "sample string 19",
        "Nickname": "sample string 20",
        "LanguageCode": "sample string 21",
        "PackageCode": "sample string 22",
        "FacilityID": 23,
        "SendAdminEmail": true
      },
      "RelUserSiteID": 1,
      "UserID": 2,
      "SiteID": 3,
      "IsDefault": true,
      "Email": "sample string 5",
      "SiteCode": "sample string 6",
      "CreatedUserID": 7
    }
  ],
  "Analyzers": [
    {
      "AnalyzerID": 1,
      "AnalyzerCode": "sample string 2",
      "AnalyzerName": "sample string 3",
      "AnalyzerSerialNumber": "sample string 4",
      "AnalyzerAbbreviation": "sample string 5",
      "AnalyzerNickname": "sample string 6",
      "ModelID": 1,
      "AnalyzerStatusID": 7,
      "LastConnectedDate": "2018-10-17T14:03:11.8737631+00:00",
      "ProcessingCapacity": 8,
      "Material": "sample string 9",
      "IsDisplayGrpLJ": true,
      "IsDisplayGrpTwin": true,
      "IsDisplayGrpXBAR": true,
      "IsDisplayGrpXBARM": true,
      "IsDisplayGrpMatrix": true,
      "IsDisplayGrpDispersal": true,
      "IsEnabled": true,
      "DisplayOrder": 1,
      "ReferenceID": "sample string 17",
      "SiteID": 18,
      "ModelCode": "sample string 19",
      "SiteCode": "sample string 20",
      "DisciplineID": 21,
      "DisciplineCode": "sample string 22",
      "CreatedUserID": 23
    },
    {
      "AnalyzerID": 1,
      "AnalyzerCode": "sample string 2",
      "AnalyzerName": "sample string 3",
      "AnalyzerSerialNumber": "sample string 4",
      "AnalyzerAbbreviation": "sample string 5",
      "AnalyzerNickname": "sample string 6",
      "ModelID": 1,
      "AnalyzerStatusID": 7,
      "LastConnectedDate": "2018-10-17T14:03:11.8737631+00:00",
      "ProcessingCapacity": 8,
      "Material": "sample string 9",
      "IsDisplayGrpLJ": true,
      "IsDisplayGrpTwin": true,
      "IsDisplayGrpXBAR": true,
      "IsDisplayGrpXBARM": true,
      "IsDisplayGrpMatrix": true,
      "IsDisplayGrpDispersal": true,
      "IsEnabled": true,
      "DisplayOrder": 1,
      "ReferenceID": "sample string 17",
      "SiteID": 18,
      "ModelCode": "sample string 19",
      "SiteCode": "sample string 20",
      "DisciplineID": 21,
      "DisciplineCode": "sample string 22",
      "CreatedUserID": 23
    }
  ],
  "SiteID": 1,
  "SiteCode": "sample string 2",
  "SiteName": "sample string 3",
  "SiteNameAlias": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "PostalCode": "sample string 8",
  "State": "sample string 9",
  "Country": "sample string 10",
  "TimeZoneName": "sample string 11",
  "IsEnabled": true,
  "Latitude": 13.1,
  "Longitude": 14.1,
  "AreaMapID": 15,
  "IsBenchmark": true,
  "CountryID": 16,
  "FacilityID": 17,
  "Facilities": {
    "FacilityPackage": [
      {
        "Packages": {
          "PackageFacility": [],
          "PackageMenu": [
            {
              "Menu": {
                "MenuPackage": [],
                "MenuID": 1,
                "MenuParentID": 2,
                "MenuCode": "sample string 3",
                "MenuName": "sample string 4",
                "MenuUrl": "sample string 5",
                "MenuUrlMulti": "sample string 6",
                "MenuIconClass": "sample string 7",
                "DisplayOrder": 8,
                "IsEnabled": true,
                "CreatedUserID": 10
              },
              "RelPackageMenuID": 1,
              "PackageID": 2,
              "MenuID": 3,
              "PackageCode": "sample string 4",
              "MenuCode": "sample string 5",
              "CreatedUserID": 6
            },
            {
              "Menu": {
                "MenuPackage": [],
                "MenuID": 1,
                "MenuParentID": 2,
                "MenuCode": "sample string 3",
                "MenuName": "sample string 4",
                "MenuUrl": "sample string 5",
                "MenuUrlMulti": "sample string 6",
                "MenuIconClass": "sample string 7",
                "DisplayOrder": 8,
                "IsEnabled": true,
                "CreatedUserID": 10
              },
              "RelPackageMenuID": 1,
              "PackageID": 2,
              "MenuID": 3,
              "PackageCode": "sample string 4",
              "MenuCode": "sample string 5",
              "CreatedUserID": 6
            }
          ],
          "Exclusions": [
            {
              "RelPackageWidgetExclusionID": 1,
              "PackageID": 2,
              "WidgetID": 3,
              "PackageCode": "sample string 4",
              "WidgetCode": "sample string 5",
              "CreatedUserID": 6
            },
            {
              "RelPackageWidgetExclusionID": 1,
              "PackageID": 2,
              "WidgetID": 3,
              "PackageCode": "sample string 4",
              "WidgetCode": "sample string 5",
              "CreatedUserID": 6
            }
          ],
          "PackageID": 1,
          "PackageCode": "sample string 2",
          "PackageName": "sample string 3",
          "Description": "sample string 4",
          "Title": "sample string 5",
          "IsCustom": true,
          "IsEnabled": true,
          "CreatedUserID": 8
        },
        "RelFacilityPackageID": 1,
        "FacilityID": 2,
        "PackageID": 3,
        "FacilityCode": "sample string 4",
        "PackageCode": "sample string 5",
        "CreatedUserID": 6
      },
      {
        "Packages": {
          "PackageFacility": [],
          "PackageMenu": [
            {
              "Menu": {
                "MenuPackage": [],
                "MenuID": 1,
                "MenuParentID": 2,
                "MenuCode": "sample string 3",
                "MenuName": "sample string 4",
                "MenuUrl": "sample string 5",
                "MenuUrlMulti": "sample string 6",
                "MenuIconClass": "sample string 7",
                "DisplayOrder": 8,
                "IsEnabled": true,
                "CreatedUserID": 10
              },
              "RelPackageMenuID": 1,
              "PackageID": 2,
              "MenuID": 3,
              "PackageCode": "sample string 4",
              "MenuCode": "sample string 5",
              "CreatedUserID": 6
            },
            {
              "Menu": {
                "MenuPackage": [],
                "MenuID": 1,
                "MenuParentID": 2,
                "MenuCode": "sample string 3",
                "MenuName": "sample string 4",
                "MenuUrl": "sample string 5",
                "MenuUrlMulti": "sample string 6",
                "MenuIconClass": "sample string 7",
                "DisplayOrder": 8,
                "IsEnabled": true,
                "CreatedUserID": 10
              },
              "RelPackageMenuID": 1,
              "PackageID": 2,
              "MenuID": 3,
              "PackageCode": "sample string 4",
              "MenuCode": "sample string 5",
              "CreatedUserID": 6
            }
          ],
          "Exclusions": [
            {
              "RelPackageWidgetExclusionID": 1,
              "PackageID": 2,
              "WidgetID": 3,
              "PackageCode": "sample string 4",
              "WidgetCode": "sample string 5",
              "CreatedUserID": 6
            },
            {
              "RelPackageWidgetExclusionID": 1,
              "PackageID": 2,
              "WidgetID": 3,
              "PackageCode": "sample string 4",
              "WidgetCode": "sample string 5",
              "CreatedUserID": 6
            }
          ],
          "PackageID": 1,
          "PackageCode": "sample string 2",
          "PackageName": "sample string 3",
          "Description": "sample string 4",
          "Title": "sample string 5",
          "IsCustom": true,
          "IsEnabled": true,
          "CreatedUserID": 8
        },
        "RelFacilityPackageID": 1,
        "FacilityID": 2,
        "PackageID": 3,
        "FacilityCode": "sample string 4",
        "PackageCode": "sample string 5",
        "CreatedUserID": 6
      }
    ],
    "FacilityID": 1,
    "FacilityCode": "sample string 2",
    "FacilityName": "sample string 3",
    "FacilityNameAlias": "sample string 4",
    "Address1": "sample string 5",
    "Address2": "sample string 6",
    "City": "sample string 7",
    "PostalCode": "sample string 8",
    "State": "sample string 9",
    "Country": "sample string 10",
    "IsEnabled": true,
    "IsNss": true,
    "CompanyID": 13,
    "Companies": {
      "CompanyID": 1,
      "CompanyCode": "sample string 2",
      "CompanyName": "sample string 3",
      "CompanyNameAlias": "sample string 4",
      "Address1": "sample string 5",
      "Address2": "sample string 6",
      "City": "sample string 7",
      "PostalCode": "sample string 8",
      "State": "sample string 9",
      "Country": "sample string 10",
      "IsEnabled": true,
      "RegionID": 12,
      "RegionCode": "sample string 13",
      "CreatedUserID": 14
    },
    "CompanyCode": "sample string 14",
    "CreatedUserID": 15
  },
  "FacilityCode": "sample string 18",
  "AreaMapCode": "sample string 19",
  "CreatedUserID": 20
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.