Get a list of available usage products

get/usage-products
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
name
string (StringFilterParam)

Filter by product name

Example: name=xyz | in:x,y | like:xyz
usageProductCategoryId
string (IdFilterParam)

Filter by usage product category

Example: usageProductCategoryId=0
availableFrom
string (DateFilterParam)

Filter by available from date

Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
availableTo
string (DateFilterParam)

Filter by available to date

Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
nominalCode
string (StringFilterParam)

Filter by nominal code

Example: nominalCode=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "nominalCode": "string",
    • "usageProductCategoryId": 1,
    • "direction": "INBOUND",
    • "performLocalAndNationalCheck": true,
    • "availableFrom": "2019-08-24",
    • "availableTo": "2019-08-24",
    • "productReferenceCanBeRange": true,
    • "serviceIdRequired": false,
    • "customFields": [
      • {
        • "id": 1,
        • "label": "string",
        • "value": "string"
        }
      ]
    }
]