Skip to content
COMMERCE QUERY
/
Application
/
/
Get Family

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://customer-slug.api-se.norce.tech/commerce/query/2.0/

Application

Operations

Get ClientCustomerFlag

Request

Get ClientCustomerFlag

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Application/ClientCustomerFlags

Responses

Success

Bodyapplication/jsonArray [
Idinteger(int32)

Id. Key property.

ClientIdinteger(int32)

ClientId.

GroupIdinteger(int32)

GroupId.

DefaultNamestring

DefaultName. MaxLength: 50. Nullable.

DefaultDescriptionstring

DefaultDescription. MaxLength: 500. Nullable.

AvailableOnCustomerboolean

AvailableOnCustomer.

AvailableOnCompanyboolean

AvailableOnCompany.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

IsDefaultboolean

IsDefault.

ExternalReferencestring

ExternalReference. MaxLength: 50. Nullable.

SortOrderinteger(int32)

SortOrder. Nullable.

Groupobject(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CustomerFlagGroup)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CustomerFlagGroup)
CulturesArray of objects(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CustomerFlagCulture)(Enferno.Storm.Query.Api.DataContexts.ApplicationModel.CustomerFlagCulture)

Cultures.

]
Response
application/json
[
  {
    "Id": 0,
    "ClientId": 0,
    "GroupId": 0,
    "DefaultName": "string",
    "DefaultDescription": "string",
    "AvailableOnCustomer": true,
    "AvailableOnCompany": true,
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "CreatedBy": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0,
    "IsDefault": true,
    "ExternalReference": "string",
    "SortOrder": 0,
    "Group": { … },
    "Cultures": [ … ]
  }
]

Get Family

Request

Get Family

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Application/Families

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.

DefaultImagePathstring

DefaultImagePath. MaxLength: 255. Nullable.

DefaultThumbnailImagePathstring

DefaultThumbnailImagePath. MaxLength: 255. Nullable.

DefaultCampaignImagePathstring

DefaultCampaignImagePath. MaxLength: 255. Nullable.

DefaultLargeImagePathstring

DefaultLargeImagePath. MaxLength: 255. Nullable.

IsActiveboolean

IsActive.

Createdstring(date-time)

Created.

CreatedByinteger(int32)

CreatedBy.

Updatedstring(date-time)

Updated. Nullable.

UpdatedByinteger(int32)

UpdatedBy. Nullable.

ImageKeystring(guid)

ImageKey. Nullable.

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

Cultures.

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

Get FileInfo

Request

Get FileInfo

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/query/2.0/Application/FileInfos

Responses

Success

Bodyapplication/jsonArray [
FileIdinteger(int32)

FileId. Key property.

ClientIdinteger(int32)

ClientId.

Codestring

Code. MaxLength: 50. Nullable.

SortOrderinteger(int32)

SortOrder. Nullable.

Updatedstring(date-time)

Updated.

UpdatedByinteger(int32)

UpdatedBy.

]
Response
application/json
[
  {
    "FileId": 0,
    "ClientId": 0,
    "Code": "string",
    "SortOrder": 0,
    "Updated": "2019-08-24T14:15:22Z",
    "UpdatedBy": 0
  }
]