Skip to content

SiteAPI

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

Method HTTP request Description
AddScenario Post /openapi/v1/{omadacId}/scenarios Create new scenario
AddTag1 Post /openapi/v1/{omadacId}/sites/tags Create new site tag
BatchSiteCopy Post /openapi/v1/{omadacId}/sites/copy Batch create sites by copying from existing site
BatchSiteImport Post /openapi/v1/{omadacId}/sites/multi-import Batch create sites by importing site backup files from file server
CreateNewSite Post /openapi/v1/{omadacId}/sites Create new site
CreateNewSiteByTemplate Post /openapi/v1/{omadacId}/sites/template Create new site from site template
DeleteScenario Delete /openapi/v1/{omadacId}/scenarios Delete site scenario
DeleteSite Delete /openapi/v1/{omadacId}/sites/{siteId} Delete an existing site
DeleteTag1 Delete /openapi/v1/{omadacId}/sites/tags Delete an existing site tag
GetAvailableSiteToBind Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/available-bind Get available site to bind template
GetNtpServerStatus Get /openapi/v1/{omadacId}/sites/{siteId}/setting/ntp Get ntp server status
GetNtpServerStatusTemplate Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/ntp Get template ntp server status
GetPlacedSitePositions Get /openapi/v1/{omadacId}/placed-site-position Obtain the geographic location information of Placed Sites
GetScenarioList Get /openapi/v1/{omadacId}/scenarios Get scenario list
GetScenarioListDifference Get /openapi/v1/{omadacId}/scenarios/difference Get scenario list difference
GetSiteDeviceAccountSetting Get /openapi/v1/{omadacId}/sites/{siteId}/device-account Get site device account setting
GetSiteEntity Get /openapi/v1/{omadacId}/sites/{siteId} Get site info
GetSiteInfoForAbnormal Get /openapi/v1/{omadacId}/sites/{siteId}/global-dashboard/site-map/abnormal Get the details of a site
GetSiteList Get /openapi/v1/{omadacId}/sites Get site list
GetSiteSummaryStatisticByOpenApi Post /openapi/v1/{omadacId}/sites/statistic Get sites statistic
GetSiteUrlByOpenApi Get /openapi/v1/{omadacId}/sites/{siteId}/url Get site url
GetTags1 Get /openapi/v1/{omadacId}/sites/tags Get site tag list
GetUnplacedSitePositions Get /openapi/v1/{omadacId}/unplaced-site-position Obtain the geographic location information of unplaced Sites
ModifyTag1 Patch /openapi/v1/{omadacId}/sites/tags Modify an existing site tag
UpdateSiteDeviceAccountSetting Put /openapi/v1/{omadacId}/sites/{siteId}/device-account Update site device account setting
UpdateSiteEntity Put /openapi/v1/{omadacId}/sites/{siteId} Modify an existing site

AddScenario

OperationResponseListString AddScenario(ctx, omadacId).Scenario(scenario).Execute()

Create new scenario

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    scenario := *openapiclient.NewScenario("Name_example") // Scenario | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

scenario | Scenario | |

Return type

OperationResponseListString

Authorization

AccessToken

HTTP request headers

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

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

AddTag1

SiteTag AddTag1(ctx, omadacId).CreateSiteTagOpenApiVO(createSiteTagOpenApiVO).Execute()

Create new site tag

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    createSiteTagOpenApiVO := *openapiclient.NewCreateSiteTagOpenApiVO() // CreateSiteTagOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

createSiteTagOpenApiVO | CreateSiteTagOpenApiVO | |

Return type

SiteTag

Authorization

AccessToken

HTTP request headers

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

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

BatchSiteCopy

OperationResponseSiteResultVO BatchSiteCopy(ctx, omadacId).BatchSiteCopyVO(batchSiteCopyVO).Execute()

Batch create sites by copying from existing site

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    batchSiteCopyVO := *openapiclient.NewBatchSiteCopyVO("SiteNamePrefix_example", "SourceSiteId_example", int32(123)) // BatchSiteCopyVO | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

batchSiteCopyVO | BatchSiteCopyVO | |

Return type

OperationResponseSiteResultVO

Authorization

AccessToken

HTTP request headers

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

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

BatchSiteImport

OperationResponseSiteResultVO BatchSiteImport(ctx, omadacId).BatchSiteImportVO(batchSiteImportVO).Execute()

Batch create sites by importing site backup files from file server

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    batchSiteImportVO := *openapiclient.NewBatchSiteImportVO(*openapiclient.NewFileServerOpenApiVO("Hostname_example", int32(123), "Protocol_example"), []openapiclient.SiteImportOpenApiVO{*openapiclient.NewSiteImportOpenApiVO("FilePath_example", "SiteName_example")}) // BatchSiteImportVO | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

batchSiteImportVO | BatchSiteImportVO | |

Return type

OperationResponseSiteResultVO

Authorization

AccessToken

HTTP request headers

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

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

CreateNewSite

CreateNewSiteResponse CreateNewSite(ctx, omadacId).CreateSiteEntity(createSiteEntity).Execute()

Create new site

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    createSiteEntity := *openapiclient.NewCreateSiteEntity(*openapiclient.NewDeviceAccountSettingOpenApiVO("Password_example", "Username_example"), "Name_example", "Region_example", "Scenario_example", "TimeZone_example") // CreateSiteEntity | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

createSiteEntity | CreateSiteEntity | |

Return type

CreateNewSiteResponse

Authorization

AccessToken

HTTP request headers

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

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

CreateNewSiteByTemplate

OperationResponse CreateNewSiteByTemplate(ctx, omadacId).CreateSiteByTemplate(createSiteByTemplate).Execute()

Create new site from site template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    createSiteByTemplate := *openapiclient.NewCreateSiteByTemplate(*openapiclient.NewDeviceAccountSettingOpenApiVO("Password_example", "Username_example"), "Name_example", "Region_example", "Scenario_example", "SiteTemplateId_example") // CreateSiteByTemplate | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

createSiteByTemplate | CreateSiteByTemplate | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

DeleteScenario

OperationResponseWithoutResult DeleteScenario(ctx, omadacId).Scenario(scenario).Execute()

Delete site scenario

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    scenario := *openapiclient.NewScenario("Name_example") // Scenario | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

scenario | Scenario | |

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]

DeleteSite

OperationResponseWithoutResult DeleteSite(ctx, omadacId, siteId).Execute()

Delete an existing site

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.DeleteSite(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.DeleteSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.DeleteSite`: %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

Other Parameters

Other parameters are passed through a pointer to a apiDeleteSiteRequest 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]

DeleteTag1

OperationResponseWithoutResult DeleteTag1(ctx, omadacId).DeleteSiteTagOpenApiVO(deleteSiteTagOpenApiVO).Execute()

Delete an existing site tag

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    deleteSiteTagOpenApiVO := *openapiclient.NewDeleteSiteTagOpenApiVO("TagId_example") // DeleteSiteTagOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

deleteSiteTagOpenApiVO | DeleteSiteTagOpenApiVO | |

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]

GetAvailableSiteToBind

OperationResponseSitesSite GetAvailableSiteToBind(ctx, omadacId, siteTemplateId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()

Get available site to bind 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
    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.
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field name (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetAvailableSiteToBind(context.Background(), omadacId, siteTemplateId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetAvailableSiteToBind``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAvailableSiteToBind`: OperationResponseSitesSite
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetAvailableSiteToBind`: %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 apiGetAvailableSiteToBindRequest 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. | searchKey | string | Fuzzy query parameters, support field name |

Return type

OperationResponseSitesSite

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetNtpServerStatus

OperationResponse GetNtpServerStatus(ctx, omadacId, siteId).Execute()

Get ntp server status

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetNtpServerStatus(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetNtpServerStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNtpServerStatus`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetNtpServerStatus`: %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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetNtpServerStatusTemplate

OperationResponse GetNtpServerStatusTemplate(ctx, omadacId, siteTemplateId).Execute()

Get template ntp server status

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetNtpServerStatusTemplate(context.Background(), omadacId, siteTemplateId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetNtpServerStatusTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNtpServerStatusTemplate`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetNtpServerStatusTemplate`: %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 apiGetNtpServerStatusTemplateRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetPlacedSitePositions

OperationResponseListPlacedSite GetPlacedSitePositions(ctx, omadacId).Execute()

Obtain the geographic location information of Placed Sites

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponseListPlacedSite

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetScenarioList

OperationResponseListString GetScenarioList(ctx, omadacId).Execute()

Get scenario list

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponseListString

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetScenarioListDifference

OperationResponseSetScenarioDifferenceVO GetScenarioListDifference(ctx, omadacId).Execute()

Get scenario list difference

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponseSetScenarioDifferenceVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSiteDeviceAccountSetting

OperationResponseDeviceAccountSettingOpenApiVO GetSiteDeviceAccountSetting(ctx, omadacId, siteId).Execute()

Get site device account setting

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetSiteDeviceAccountSetting(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetSiteDeviceAccountSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSiteDeviceAccountSetting`: OperationResponseDeviceAccountSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetSiteDeviceAccountSetting`: %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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponseDeviceAccountSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSiteEntity

OperationResponseSiteEntity GetSiteEntity(ctx, omadacId, siteId).Execute()

Get site 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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetSiteEntity(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetSiteEntity``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSiteEntity`: OperationResponseSiteEntity
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetSiteEntity`: %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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponseSiteEntity

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSiteInfoForAbnormal

OperationResponse GetSiteInfoForAbnormal(ctx, omadacId, siteId).Execute()

Get the details of a site

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetSiteInfoForAbnormal(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetSiteInfoForAbnormal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSiteInfoForAbnormal`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetSiteInfoForAbnormal`: %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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSiteList

OperationResponseGridVOSiteSummaryInfo GetSiteList(ctx, omadacId).Page(page).PageSize(pageSize).SortsName(sortsName).SearchKey(searchKey).FiltersTag(filtersTag).FiltersType(filtersType).Execute()

Get site list

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    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.
    sortsName := "sortsName_example" // string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect (optional)
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field name (optional)
    filtersTag := "filtersTag_example" // string | Filter query parameters, support field tag ID (optional)
    filtersType := "filtersType_example" // string | Filter query parameters, support field site type. 0: basic site; 1: pro site. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetSiteList(context.Background(), omadacId).Page(page).PageSize(pageSize).SortsName(sortsName).SearchKey(searchKey).FiltersTag(filtersTag).FiltersType(filtersType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetSiteList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSiteList`: OperationResponseGridVOSiteSummaryInfo
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetSiteList`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGetSiteListRequest 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. | sortsName | string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect | searchKey | string | Fuzzy query parameters, support field name | filtersTag | string | Filter query parameters, support field tag ID | filtersType | string | Filter query parameters, support field site type. 0: basic site; 1: pro site. |

Return type

OperationResponseGridVOSiteSummaryInfo

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSiteSummaryStatisticByOpenApi

OperationResponseSiteSummaryStatistic GetSiteSummaryStatisticByOpenApi(ctx, omadacId).SiteStatisticList(siteStatisticList).Execute()

Get sites statistic

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteStatisticList := *openapiclient.NewSiteStatisticList() // SiteStatisticList | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

siteStatisticList | SiteStatisticList | |

Return type

OperationResponseSiteSummaryStatistic

Authorization

AccessToken

HTTP request headers

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

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

GetSiteUrlByOpenApi

OperationResponseSiteUrlOpenApiVO GetSiteUrlByOpenApi(ctx, omadacId, siteId).Execute()

Get site url

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.GetSiteUrlByOpenApi(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.GetSiteUrlByOpenApi``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSiteUrlByOpenApi`: OperationResponseSiteUrlOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.GetSiteUrlByOpenApi`: %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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponseSiteUrlOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetTags1

[]SiteTag GetTags1(ctx, omadacId).Execute()

Get site tag list

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]SiteTag

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetUnplacedSitePositions

OperationResponseUnplacedSitesUnplacedSite GetUnplacedSitePositions(ctx, omadacId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()

Obtain the geographic location information of unplaced Sites

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    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.
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field name (optional)

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGetUnplacedSitePositionsRequest 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. | searchKey | string | Fuzzy query parameters, support field name |

Return type

OperationResponseUnplacedSitesUnplacedSite

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

ModifyTag1

OperationResponseWithoutResult ModifyTag1(ctx, omadacId).SiteTag(siteTag).Execute()

Modify an existing site tag

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTag := *openapiclient.NewSiteTag() // SiteTag | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

siteTag | SiteTag | |

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]

UpdateSiteDeviceAccountSetting

OperationResponseWithoutResult UpdateSiteDeviceAccountSetting(ctx, omadacId, siteId).DeviceAccountSettingOpenApiVO(deviceAccountSettingOpenApiVO).Execute()

Update site device account setting

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
    deviceAccountSettingOpenApiVO := *openapiclient.NewDeviceAccountSettingOpenApiVO("Password_example", "Username_example") // DeviceAccountSettingOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.UpdateSiteDeviceAccountSetting(context.Background(), omadacId, siteId).DeviceAccountSettingOpenApiVO(deviceAccountSettingOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.UpdateSiteDeviceAccountSetting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateSiteDeviceAccountSetting`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.UpdateSiteDeviceAccountSetting`: %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

Other Parameters

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

Name Type Description Notes

deviceAccountSettingOpenApiVO | DeviceAccountSettingOpenApiVO | |

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]

UpdateSiteEntity

OperationResponseWithoutResult UpdateSiteEntity(ctx, omadacId, siteId).UpdateSiteEntity(updateSiteEntity).Execute()

Modify an existing site

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
    updateSiteEntity := *openapiclient.NewUpdateSiteEntity("Region_example", "Scenario_example", "TimeZone_example") // UpdateSiteEntity | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SiteAPI.UpdateSiteEntity(context.Background(), omadacId, siteId).UpdateSiteEntity(updateSiteEntity).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.UpdateSiteEntity``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateSiteEntity`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `SiteAPI.UpdateSiteEntity`: %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

Other Parameters

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

Name Type Description Notes

updateSiteEntity | UpdateSiteEntity | |

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]