STORM QUERY
/
Application
/
Application
/
Get ApplicationRole

Storm Query API Documentation (2.0)

Storm Query API is an API based on OData V4. It is an API to fill the need for data from Storm in integration services that do not have direct access to Storm’s data and data models.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://query.storm.io/Query/2.0/

Schemas

Application

Operations

Get ApplicationSalesArea

Request

Get ApplicationSalesArea

curl -i -X GET \
  https://query.storm.io/Query/2.0/Application/ApplicationSalesAreas

Responses

Success

Bodyapplication/jsonArray [
ApplicationIdinteger(int32)

ApplicationId. Key property.

SalesAreaIdinteger(int32)

SalesAreaId. Key property.

IsPrimaryboolean

IsPrimary.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

]
Response
application/json
[
  {
    "ApplicationId": 0,
    "SalesAreaId": 0,
    "IsPrimary": true,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "ClientId": 0
  }
]

Get ApplicationRole

Request

Get ApplicationRole

curl -i -X GET \
  https://query.storm.io/Query/2.0/Application/ApplicationRoles

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ApplicationIdinteger(int32)

ApplicationId. Nullable.

ClientIdinteger(int32)

ClientId. Nullable.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

ReplacesApplicationRoleIdinteger(int32)

ReplacesApplicationRoleId. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

IsDefaultboolean

IsDefault.

Codestring

Code. MaxLength: 50. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.ApplicationRoleCulture)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.ApplicationRoleCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "ApplicationId": 0,
    "ClientId": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "ReplacesApplicationRoleId": 0,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "IsDefault": true,
    "Code": "string",
    "Cultures": [ … ]
  }
]

Get Category

Request

Get Category

curl -i -X GET \
  https://query.storm.io/Query/2.0/Application/Categories

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

Codestring

Code. MaxLength: 50. Nullable.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. Nullable.

DefaultSynonymsstring

DefaultSynonyms. MaxLength: 500. Nullable.

DefaultImagePathstring

DefaultImagePath. MaxLength: 255. Nullable.

UnspcCodestring

UnspcCode. MaxLength: 50. Nullable.

BusinessAreastring

BusinessArea. MaxLength: 50. Nullable.

DefaultCommodityCodestring

DefaultCommodityCode. MaxLength: 50. Nullable.

DefaultIntegrationPartNostring

DefaultIntegrationPartNo. MaxLength: 50. Nullable.

DefaultTrackingCodeTypeIdinteger(int32)

DefaultTrackingCodeTypeId. Nullable.

FreightClassIdinteger(int32)

FreightClassId. Nullable.

DefaultGrossWeightnumber(decimal)

DefaultGrossWeight. Nullable.

DefaultNetWeightnumber(decimal)

DefaultNetWeight. Nullable.

DefaultUnitOfMeasurementIdinteger(int32)

DefaultUnitOfMeasurementId. Nullable.

DefaultPackageIdinteger(int32)

DefaultPackageId. Nullable.

DefaultIsReturnableboolean

DefaultIsReturnable. Nullable.

DefaultIsDropShipOnlyboolean

DefaultIsDropShipOnly. Nullable.

InsuranceCurrencyIdinteger(int32)

InsuranceCurrencyId. Nullable.

InsuranceStartPricenumber(decimal)

InsuranceStartPrice. Nullable.

InsuranceRunningPercentagenumber(decimal)

InsuranceRunningPercentage. Nullable.

PopulationRuleIdinteger(int32)

PopulationRuleId.

HideInTopListboolean

HideInTopList.

PhoneNumberstring

PhoneNumber. MaxLength: 255. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

CompetitivePricingMinPercentagenumber(decimal)

CompetitivePricingMinPercentage. Nullable.

CompetitivePricingTargetPercentagenumber(decimal)

CompetitivePricingTargetPercentage. Nullable.

DefaultVariantGroupIdinteger(int32)

DefaultVariantGroupId. Nullable.

DefaultRecommendedSalesQtynumber(decimal)

DefaultRecommendedSalesQty. Nullable.

ImageKeystring(guid)

ImageKey. Nullable.

DefaultFullNamestring

DefaultFullName. MaxLength: 500. Nullable.

StructureSortOrderstring

StructureSortOrder. Nullable.

DefaultStockDisplayBreakPointinteger(int32)

DefaultStockDisplayBreakPoint. Nullable.

DefaultIsRecommendedSalesQtyFixedboolean

DefaultIsRecommendedSalesQtyFixed. Nullable.

DefaultIsRecurringOrderableboolean

DefaultIsRecurringOrderable. Nullable.

CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryCulture)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryCulture)

Cultures.

SalesAreasArray of objects(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategorySalesArea)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategorySalesArea)

SalesAreas.

ParametricsArray of objects(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryParametric)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CategoryParametric)

Parametrics.

]
Response
application/json
[
  {
    "Id": 0,
    "ClientId": 0,
    "Code": "string",
    "DefaultName": "string",
    "DefaultDescription": "string",
    "DefaultSynonyms": "string",
    "DefaultImagePath": "string",
    "UnspcCode": "string",
    "BusinessArea": "string",
    "DefaultCommodityCode": "string",
    "DefaultIntegrationPartNo": "string",
    "DefaultTrackingCodeTypeId": 0,
    "FreightClassId": 0,
    "DefaultGrossWeight": 0,
    "DefaultNetWeight": 0,
    "DefaultUnitOfMeasurementId": 0,
    "DefaultPackageId": 0,
    "DefaultIsReturnable": true,
    "DefaultIsDropShipOnly": true,
    "InsuranceCurrencyId": 0,
    "InsuranceStartPrice": 0,
    "InsuranceRunningPercentage": 0,
    "PopulationRuleId": 0,
    "HideInTopList": true,
    "PhoneNumber": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "CompetitivePricingMinPercentage": 0,
    "CompetitivePricingTargetPercentage": 0,
    "DefaultVariantGroupId": 0,
    "DefaultRecommendedSalesQty": 0,
    "ImageKey": "string",
    "DefaultFullName": "string",
    "StructureSortOrder": "string",
    "DefaultStockDisplayBreakPoint": 0,
    "DefaultIsRecommendedSalesQtyFixed": true,
    "DefaultIsRecurringOrderable": true,
    "Cultures": [ … ],
    "SalesAreas": [ … ],
    "Parametrics": [ … ]
  }
]