GET api/CRMFacility

Get Facilities

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Facilities
NameDescriptionTypeAdditional information
FacilityPackage

Collection of RelFacilityPackages

None.

FacilityID

integer

None.

FacilityCode

string

Required

String length: inclusive between 0 and 35

FacilityName

string

Required

String length: inclusive between 0 and 100

FacilityNameAlias

string

String length: inclusive between 0 and 10

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

IsEnabled

boolean

None.

IsNss

boolean

None.

CompanyID

integer

None.

Companies

Companies

None.

CompanyCode

string

None.

CreatedUserID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "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
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.