OLTServicePortAPI

All URIs are relative to https://use1-omada-northbound.tplinkcloud.com

Method	HTTP request	Description
AddServicePort	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/add	Create new service port
ClearStatisticInfo	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/clear	Batch delete existing statistic info
DeleteServicePort	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/delete	Batch delete existing service port
EditAutoRefreshConfig	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistic/configs/edit	Modify an existing auto refresh config
EditAutoServicePort	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/auto-service-ports/edit	Batch modify auto service port
EditServicePort	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/edit	Modify an existing service port
GetAutoRefreshConfig	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistic/configs	Get auto refresh config
GetAutoServicePortConfigPage	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/auto-service-ports/page	Get auto service port config page
GetAutoServicePortList	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/auto-service-ports/list	Get auto service port list
GetServicePortList	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/list	Get service port list
GetServicePortPage	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/page	Get service port page
GetStatisticInfoDetail	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/detail	Get statistic info detail
GetStatisticInfoList	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/list	Get statistic info list
GetStatisticInfoPage	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/page	Get statistic info page

AddServicePort

OperationResponseDeviceResponseBodyVoid AddServicePort(ctx, omadacId, siteId, deviceMac).ServicePortAddDTO(servicePortAddDTO).Execute()

Create new service port

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    servicePortAddDTO := *openapiclient.NewServicePortAddDTO("AdminStatus_example", false, "OnuId_example", "StatisticPerformance_example") // ServicePortAddDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.AddServicePort(context.Background(), omadacId, siteId, deviceMac).ServicePortAddDTO(servicePortAddDTO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.AddServicePort``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddServicePort`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.AddServicePort`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiAddServicePortRequest struct via the builder pattern

Name	Type	Description	Notes

servicePortAddDTO | ServicePortAddDTO | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClearStatisticInfo

OperationResponseDeviceResponseBodyVoid ClearStatisticInfo(ctx, omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()

Batch delete existing statistic info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    intIdListRequest := *openapiclient.NewIntIdListRequest([]int32{int32(123)}) // IntIdListRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.ClearStatisticInfo(context.Background(), omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.ClearStatisticInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ClearStatisticInfo`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.ClearStatisticInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiClearStatisticInfoRequest struct via the builder pattern

Name	Type	Description	Notes

intIdListRequest | IntIdListRequest | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteServicePort

OperationResponseDeviceResponseBodyVoid DeleteServicePort(ctx, omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()

Batch delete existing service port

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    intIdListRequest := *openapiclient.NewIntIdListRequest([]int32{int32(123)}) // IntIdListRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.DeleteServicePort(context.Background(), omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.DeleteServicePort``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteServicePort`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.DeleteServicePort`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiDeleteServicePortRequest struct via the builder pattern

Name	Type	Description	Notes

intIdListRequest | IntIdListRequest | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditAutoRefreshConfig

OperationResponseDeviceResponseBodyVoid EditAutoRefreshConfig(ctx, omadacId, siteId, deviceMac).StatisticConfigDTO(statisticConfigDTO).Execute()

Modify an existing auto refresh config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    statisticConfigDTO := *openapiclient.NewStatisticConfigDTO() // StatisticConfigDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.EditAutoRefreshConfig(context.Background(), omadacId, siteId, deviceMac).StatisticConfigDTO(statisticConfigDTO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.EditAutoRefreshConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EditAutoRefreshConfig`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.EditAutoRefreshConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiEditAutoRefreshConfigRequest struct via the builder pattern

Name	Type	Description	Notes

statisticConfigDTO | StatisticConfigDTO | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditAutoServicePort

OperationResponseDeviceResponseBodyVoid EditAutoServicePort(ctx, omadacId, siteId, deviceMac).AutoServicePortDTO(autoServicePortDTO).Execute()

Batch modify auto service port

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    autoServicePortDTO := []openapiclient.AutoServicePortDTO{*openapiclient.NewAutoServicePortDTO()} // []AutoServicePortDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.EditAutoServicePort(context.Background(), omadacId, siteId, deviceMac).AutoServicePortDTO(autoServicePortDTO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.EditAutoServicePort``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EditAutoServicePort`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.EditAutoServicePort`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiEditAutoServicePortRequest struct via the builder pattern

Name	Type	Description	Notes

autoServicePortDTO | []AutoServicePortDTO | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditServicePort

OperationResponseDeviceResponseBodyVoid EditServicePort(ctx, omadacId, siteId, deviceMac).ServicePortModifyDTO(servicePortModifyDTO).Execute()

Modify an existing service port

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    servicePortModifyDTO := *openapiclient.NewServicePortModifyDTO("AdminStatus_example", int32(123), int32(123), "StatisticPerformance_example") // ServicePortModifyDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.EditServicePort(context.Background(), omadacId, siteId, deviceMac).ServicePortModifyDTO(servicePortModifyDTO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.EditServicePort``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EditServicePort`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.EditServicePort`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiEditServicePortRequest struct via the builder pattern

Name	Type	Description	Notes

servicePortModifyDTO | ServicePortModifyDTO | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAutoRefreshConfig

OperationResponseStatisticConfigDTO GetAutoRefreshConfig(ctx, omadacId, siteId, deviceMac).Execute()

Get auto refresh config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetAutoRefreshConfig(context.Background(), omadacId, siteId, deviceMac).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetAutoRefreshConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAutoRefreshConfig`: OperationResponseStatisticConfigDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetAutoRefreshConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetAutoRefreshConfigRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseStatisticConfigDTO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAutoServicePortConfigPage

OperationResponsePageResponseAutoServicePortVO GetAutoServicePortConfigPage(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get auto service port config page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewAutoServicePortQueryDTO() // AutoServicePortQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetAutoServicePortConfigPage(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetAutoServicePortConfigPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAutoServicePortConfigPage`: OperationResponsePageResponseAutoServicePortVO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetAutoServicePortConfigPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetAutoServicePortConfigPageRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | AutoServicePortQueryDTO | |

Return type

OperationResponsePageResponseAutoServicePortVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAutoServicePortList

OperationResponseListAutoServicePortVO GetAutoServicePortList(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get auto service port list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewAutoServicePortQueryDTO() // AutoServicePortQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetAutoServicePortList(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetAutoServicePortList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAutoServicePortList`: OperationResponseListAutoServicePortVO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetAutoServicePortList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetAutoServicePortListRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | AutoServicePortQueryDTO | |

Return type

OperationResponseListAutoServicePortVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServicePortList

OperationResponseListServicePortVO GetServicePortList(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get service port list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewServicePortQueryDTO() // ServicePortQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetServicePortList(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetServicePortList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetServicePortList`: OperationResponseListServicePortVO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetServicePortList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetServicePortListRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | ServicePortQueryDTO | |

Return type

OperationResponseListServicePortVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServicePortPage

OperationResponsePageResponseServicePortVO GetServicePortPage(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get service port page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewServicePortQueryDTO() // ServicePortQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetServicePortPage(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetServicePortPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetServicePortPage`: OperationResponsePageResponseServicePortVO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetServicePortPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetServicePortPageRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | ServicePortQueryDTO | |

Return type

OperationResponsePageResponseServicePortVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatisticInfoDetail

OperationResponseStatisticInfoDetailDTO GetStatisticInfoDetail(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get statistic info detail

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewStatisticInfoDetailQueryDTO(int32(123)) // StatisticInfoDetailQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetStatisticInfoDetail(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetStatisticInfoDetail``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetStatisticInfoDetail`: OperationResponseStatisticInfoDetailDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetStatisticInfoDetail`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetStatisticInfoDetailRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | StatisticInfoDetailQueryDTO | |

Return type

OperationResponseStatisticInfoDetailDTO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatisticInfoList

OperationResponseListStatisticInfoDTO GetStatisticInfoList(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get statistic info list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewStatisticInfoQueryDTO() // StatisticInfoQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetStatisticInfoList(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetStatisticInfoList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetStatisticInfoList`: OperationResponseListStatisticInfoDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetStatisticInfoList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetStatisticInfoListRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | StatisticInfoQueryDTO | |

Return type

OperationResponseListStatisticInfoDTO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatisticInfoPage

OperationResponsePageResponseStatisticInfoDTO GetStatisticInfoPage(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get statistic info page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewStatisticInfoQueryDTO() // StatisticInfoQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTServicePortAPI.GetStatisticInfoPage(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTServicePortAPI.GetStatisticInfoPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetStatisticInfoPage`: OperationResponsePageResponseStatisticInfoDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTServicePortAPI.GetStatisticInfoPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetStatisticInfoPageRequest struct via the builder pattern

Name	Type	Description	Notes

queryParam | StatisticInfoQueryDTO | |

Return type

OperationResponsePageResponseStatisticInfoDTO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]