API introspection – List packages, resources and their interfaces

Found 8 resources

Resource class Tesa\Flow\Controller\Business\Api\V1\CustomerController of type CollectionController
No access control

Skeleton class for controlling a collection of rows from the 'CustomerModel' table.

Name Type Size Default Description Visible Mutable Nullable
Uuid VARCHAR 36 not set yes no no
Orphaned BOOLEAN yes no no
SalesPersonIdentifier VARCHAR 128 not set C1 Sales force name yes no yes
CompanyCode VARCHAR 5 not set A1 Large customers yes no yes
DepartmentCode VARCHAR 5 not set A3 Large customers yes no yes
CustomerCode VARCHAR 10 not set Sold-to (10-digit) yes no no
Class ENUM D The customer class; Value set: A, B, C, D yes no no
BasicDiscount FLOAT 0 Grundrabatt aktuell yes no no
FocusDiscount FLOAT 0 Fokusrabatt aktuell yes no no
Name VARCHAR 128 not set Customer organization name yes no no
CurrentGrossRevenue FLOAT 0 PS yes no no
ReferenceGrossRevenue FLOAT 0 PS LY comp. yes no no
PreviousYearGrossRevenue FLOAT 0 PS LY total yes no no
GrossRevenueAbsoluteDeviation FLOAT 0 PS dvlp. yes no no
GrossRevenueDeviation FLOAT 0 PS dvlp. % yes no no
CurrentNetRevenue FLOAT 0 PNS yes no no
ReferenceNetRevenue FLOAT 0 PNS LY comp. yes no no
PreviousYearNetRevenue FLOAT 0 PNS LY total yes no no
NetRevenueDeviation FLOAT 0 PNS dvlp. % yes no no
CurrentAbsoluteMargin FLOAT 0 MI PNS yes no no
CurrentRelativeMargin FLOAT 0 MI PNS % yes no no
ReferenceAbsoluteMargin FLOAT 0 MI PNS LY comp. yes no no
ReferenceRelativeMargin FLOAT 0 MI PNS % LY yes no no
RelativeMarginDeviation FLOAT 0 MI PNS dev. pp yes no no
RevenueKpi FLOAT 0 Customer KPI based on revenue yes no no
MarginKpi FLOAT 0 Customer KPI based on margin yes no no
CombinedKpi FLOAT 0 Combined customer KPI based on margin and revenue yes no no
CombinedKpiSource ENUM not set Source of the combined customer KPI; Value set: REVENUE, MARGIN yes no no
AddressPostcode VARCHAR 5 not set Customers address postcode yes no no
AddressCity VARCHAR 128 not set Customers address city yes no no
AddressStreet VARCHAR 128 not set Customers address street yes no no
AddressGeoLocationLatitude FLOAT not set yes no yes
AddressGeoLocationLongitude FLOAT not set yes no yes

Interfaces

Found 2 interfaces in class Tesa\Flow\Controller\Business\Api\V1\CustomerController

Resource: Customer, Method: find

Loads a model collection or throws an exception

Endpoint
GET /business/api/v1/customer/
Example request 
GET /business/api/v1/customer
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
If-Modified-Since: Wed, 30 Sep 2020 12:55:40 GMT

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:40 +0000
Content-Length: 2645
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "CustomerModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "SalesPersonIdentifier": "JDOE",
            "CompanyCode": "06193",
            "DepartmentCode": "06193",
            "CustomerCode": "0000385272",
            "Class": "B",
            "BasicDiscount": -20,
            "FocusDiscount": -25,
            "Name": "Univend Spezialautomaten",
            "CurrentGrossRevenue": 30.6,
            "ReferenceGrossRevenue": 30.6,
            "PreviousYearGrossRevenue": 30.6,
            "GrossRevenueAbsoluteDeviation": 142.6,
            "GrossRevenueDeviation": 142.6,
            "CurrentNetRevenue": 30.6,
            "ReferenceNetRevenue": 30.6,
            "PreviousYearNetRevenue": 30.6,
            "NetRevenueDeviation": 148.5,
            "CurrentAbsoluteMargin": 30.6,
            "CurrentRelativeMargin": 70.9,
            "ReferenceAbsoluteMargin": 26,
            "ReferenceRelativeMargin": 70.7,
            "RelativeMarginDeviation": 0.2,
            "RevenueKpi": 8.425,
            "MarginKpi": 8.425,
            "CombinedKpi": 8.425,
            "CombinedKpiSource": "REVENUE",
            "AddressPostcode": "10405",
            "AddressCity": "Berlin",
            "AddressStreet": "Kollwitzstraße 45",
            "AddressGeoLocationLatitude": 54.333792,
            "AddressGeoLocationLongitude": 10.136643
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "CustomerModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer Token named Authorization
ISO 8601 Timestamp Provided By The `Last-Modified` Response Header Of The Last Reqeust named If-Modified-Since // Optional
Response header
ISO 8601 Timestamp named Last-Modified // Optional
Response data
FilteredCustomerControllerModel[] named CustomerModelCollection

Resource: Customer, Method: page

Loads an paginated model collection or throws an exception

The number of items per page is defined in the class property $modelsPerPage

Endpoint
GET /business/api/v1/customer/page/{?page}/
Example request 
GET /business/api/v1/customer/page/{?page}
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
If-Modified-Since: Wed, 30 Sep 2020 12:55:40 GMT

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:40 +0000
Content-Length: 2645
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "CustomerModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "SalesPersonIdentifier": "JDOE",
            "CompanyCode": "06193",
            "DepartmentCode": "06193",
            "CustomerCode": "0000385272",
            "Class": "B",
            "BasicDiscount": -20,
            "FocusDiscount": -25,
            "Name": "Univend Spezialautomaten",
            "CurrentGrossRevenue": 30.6,
            "ReferenceGrossRevenue": 30.6,
            "PreviousYearGrossRevenue": 30.6,
            "GrossRevenueAbsoluteDeviation": 142.6,
            "GrossRevenueDeviation": 142.6,
            "CurrentNetRevenue": 30.6,
            "ReferenceNetRevenue": 30.6,
            "PreviousYearNetRevenue": 30.6,
            "NetRevenueDeviation": 148.5,
            "CurrentAbsoluteMargin": 30.6,
            "CurrentRelativeMargin": 70.9,
            "ReferenceAbsoluteMargin": 26,
            "ReferenceRelativeMargin": 70.7,
            "RelativeMarginDeviation": 0.2,
            "RevenueKpi": 8.425,
            "MarginKpi": 8.425,
            "CombinedKpi": 8.425,
            "CombinedKpiSource": "REVENUE",
            "AddressPostcode": "10405",
            "AddressCity": "Berlin",
            "AddressStreet": "Kollwitzstraße 45",
            "AddressGeoLocationLatitude": 54.333792,
            "AddressGeoLocationLongitude": 10.136643
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "CustomerModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer Token named Authorization
ISO 8601 Timestamp Provided By The `Last-Modified` Response Header Of The Last Reqeust named If-Modified-Since // Optional
Response header
ISO 8601 Timestamp named Last-Modified // Optional
Response data
FilteredCustomerControllerModel[] named CustomerModelCollection