GET api/CRMPackage

Get Packages

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Packages
NameDescriptionTypeAdditional information
PackageFacility

Collection of RelFacilityPackages

None.

PackageMenu

Collection of RelPackageMenu

None.

Exclusions

Collection of RelPackageWidgetExclusions

None.

PackageID

integer

None.

PackageCode

string

Required

String length: inclusive between 0 and 50

PackageName

string

Required

String length: inclusive between 0 and 200

Description

string

String length: inclusive between 0 and 1000

Title

string

String length: inclusive between 0 and 50

IsCustom

boolean

None.

IsEnabled

boolean

None.

CreatedUserID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "PackageFacility": [
    {
      "Facilities": {
        "FacilityPackage": [],
        "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
      },
      "RelFacilityPackageID": 1,
      "FacilityID": 2,
      "PackageID": 3,
      "FacilityCode": "sample string 4",
      "PackageCode": "sample string 5",
      "CreatedUserID": 6
    },
    {
      "Facilities": {
        "FacilityPackage": [],
        "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
      },
      "RelFacilityPackageID": 1,
      "FacilityID": 2,
      "PackageID": 3,
      "FacilityCode": "sample string 4",
      "PackageCode": "sample string 5",
      "CreatedUserID": 6
    }
  ],
  "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
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.