OLTTContAPI

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

Method	HTTP request	Description
AddTcont	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/add	Create new t-cont
DeleteTcont	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/delete	Delete an existing t-cont
EditTcont	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/edit	Modify an existing t-cont
GetTcontList	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/list	Get t-cont list
GetTcontPage	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/page	Get t-cont page

AddTcont

OperationResponseDeviceResponseBodyVoid AddTcont(ctx, omadacId, siteId, deviceMac, lineProfileId).TcontDTO(tcontDTO).Execute()

Create new t-cont

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
    lineProfileId := "lineProfileId_example" // string | Line Profile ID should be a number between 0-512
    tcontDTO := *openapiclient.NewTcontDTO(int32(123), int32(123)) // TcontDTO | 

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

Path Parameters

Name	Type	Description
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
lineProfileId	string	Line Profile ID should be a number between 0-512

Other Parameters

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

Name	Type	Description	Notes

tcontDTO | TcontDTO | |

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]

DeleteTcont

OperationResponseDeviceResponseBodyTcontDeleteResultDTO DeleteTcont(ctx, omadacId, siteId, deviceMac, lineProfileId).TcontDeleteDTO(tcontDeleteDTO).Execute()

Delete an existing t-cont

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
    lineProfileId := "lineProfileId_example" // string | Line Profile ID should be a number between 0-512
    tcontDeleteDTO := *openapiclient.NewTcontDeleteDTO([]int32{int32(123)}) // TcontDeleteDTO | 

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

Path Parameters

Name	Type	Description
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
lineProfileId	string	Line Profile ID should be a number between 0-512

Other Parameters

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

Name	Type	Description	Notes

tcontDeleteDTO | TcontDeleteDTO | |

Return type

OperationResponseDeviceResponseBodyTcontDeleteResultDTO

Authorization

AccessToken

HTTP request headers

Content-Type: application/json
Accept: /

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

EditTcont

OperationResponseDeviceResponseBodyVoid EditTcont(ctx, omadacId, siteId, deviceMac, lineProfileId).TcontModifyDTO(tcontModifyDTO).Execute()

Modify an existing t-cont

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
    lineProfileId := "lineProfileId_example" // string | Line Profile ID should be a number between 0-512
    tcontModifyDTO := *openapiclient.NewTcontModifyDTO(int32(123)) // TcontModifyDTO | 

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

Path Parameters

Name	Type	Description
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
lineProfileId	string	Line Profile ID should be a number between 0-512

Other Parameters

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

Name	Type	Description	Notes

tcontModifyDTO | TcontModifyDTO | |

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]

GetTcontList

OperationResponseListTcontVO GetTcontList(ctx, omadacId, siteId, deviceMac, lineProfileId).QueryParam(queryParam).Execute()

Get t-cont 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
    lineProfileId := "lineProfileId_example" // string | Line Profile ID should be a number between 0-512
    queryParam := *openapiclient.NewTcontListQueryDTO() // TcontListQueryDTO | 

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

Path Parameters

Name	Type	Description
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
lineProfileId	string	Line Profile ID should be a number between 0-512

Other Parameters

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

Name	Type	Description	Notes

queryParam | TcontListQueryDTO | |

Return type

OperationResponseListTcontVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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

GetTcontPage

OperationResponsePageResponseTcontVO GetTcontPage(ctx, omadacId, siteId, deviceMac, lineProfileId).QueryParam(queryParam).Execute()

Get t-cont 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
    lineProfileId := "lineProfileId_example" // string | Line Profile ID should be a number between 0-512
    queryParam := *openapiclient.NewTcontPageQueryDTO() // TcontPageQueryDTO | 

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

Path Parameters

Name	Type	Description
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
lineProfileId	string	Line Profile ID should be a number between 0-512

Other Parameters

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

Name	Type	Description	Notes

queryParam | TcontPageQueryDTO | |

Return type

OperationResponsePageResponseTcontVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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