LanMulticastTemplateAPI

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

Method	HTTP request	Description
CreateLanMulticastTemplate	Post /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-multicasts	Create new lan multicast template
DeleteLanMulticastTemplate	Delete /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-multicasts/{multicastId}	Delete an existing lan multicast template
GetGridLanMulticastTemplates	Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-multicasts	Get lan multicast template list
ModifyLanMulticastTemplate	Patch /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-multicasts/{multicastId}	Modify a lan multicast template

CreateLanMulticastTemplate

OperationResponseResponseIdVO CreateLanMulticastTemplate(ctx, omadacId, siteTemplateId).LanMulticastVO(lanMulticastVO).Execute()

Create new lan multicast template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    lanMulticastVO := *openapiclient.NewLanMulticastVO() // LanMulticastVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanMulticastTemplateAPI.CreateLanMulticastTemplate(context.Background(), omadacId, siteTemplateId).LanMulticastVO(lanMulticastVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanMulticastTemplateAPI.CreateLanMulticastTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLanMulticastTemplate`: OperationResponseResponseIdVO
    fmt.Fprintf(os.Stdout, "Response from `LanMulticastTemplateAPI.CreateLanMulticastTemplate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteTemplateId	string	Site Template ID

Other Parameters

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

Name	Type	Description	Notes

lanMulticastVO | LanMulticastVO | |

Return type

OperationResponseResponseIdVO

Authorization

AccessToken

HTTP request headers

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

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

DeleteLanMulticastTemplate

OperationResponseWithoutResult DeleteLanMulticastTemplate(ctx, omadacId, siteTemplateId, multicastId).Execute()

Delete an existing lan multicast template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    multicastId := "multicastId_example" // string | lanMulticastId

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteTemplateId	string	Site Template ID
multicastId	string	lanMulticastId

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetGridLanMulticastTemplates

OperationResponseGridVOLanMulticastVO GetGridLanMulticastTemplates(ctx, omadacId, siteTemplateId).Page(page).PageSize(pageSize).Execute()

Get lan multicast template list

Example

package main

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

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanMulticastTemplateAPI.GetGridLanMulticastTemplates(context.Background(), omadacId, siteTemplateId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanMulticastTemplateAPI.GetGridLanMulticastTemplates``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridLanMulticastTemplates`: OperationResponseGridVOLanMulticastVO
    fmt.Fprintf(os.Stdout, "Response from `LanMulticastTemplateAPI.GetGridLanMulticastTemplates`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteTemplateId	string	Site Template ID

Other Parameters

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

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseGridVOLanMulticastVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

ModifyLanMulticastTemplate

OperationResponseWithoutResult ModifyLanMulticastTemplate(ctx, omadacId, siteTemplateId, multicastId).LanMulticastVO(lanMulticastVO).Execute()

Modify a lan multicast template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    multicastId := "multicastId_example" // string | lanMulticastId
    lanMulticastVO := *openapiclient.NewLanMulticastVO() // LanMulticastVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanMulticastTemplateAPI.ModifyLanMulticastTemplate(context.Background(), omadacId, siteTemplateId, multicastId).LanMulticastVO(lanMulticastVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanMulticastTemplateAPI.ModifyLanMulticastTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLanMulticastTemplate`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LanMulticastTemplateAPI.ModifyLanMulticastTemplate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteTemplateId	string	Site Template ID
multicastId	string	lanMulticastId

Other Parameters

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

Name	Type	Description	Notes

lanMulticastVO | LanMulticastVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

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

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