Manage Site

Updates and gets site details, and deletes a site.

Gets site details.

Path Parameters

  • siteIdstringrequired

    Site uuid

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

  • idinteger

  • namestring

    Site name.

  • clientIdinteger

  • mspIdinteger

  • parentobject

    (Optional) Parent site. Required if creating a sub-site under a parent site:

  • descriptionstring

    (Optional) Summary of the site.

  • addressstring

    (Optional) Site address.

  • statestring

    (Optional) Site state.

  • citystring

    (Optional) Site city.

  • countrystring

  • zipstring

    (Optional) Zip code.

  • primaryContactobject

  • phoneNumberstring

    (Optional) Site phone number for communication.

  • phoneExtensionstring

    (Optional) Site phone extension number.

  • filterCriteriaobject

  • devicesarray

  • resourcesarray

Loading Examples...

Updates site details.

Path Parameters

  • siteIdstringrequired

    Site uuid

  • clientIdstringrequired

    Describes the clientId of the tenant

Request Body

application/json

  • idinteger

  • namestring

    Site name.

  • clientIdinteger

  • mspIdinteger

  • parentobject

    (Optional) Parent site. Required if creating a sub-site under a parent site:

  • descriptionstring

    (Optional) Summary of the site.

  • addressstring

    (Optional) Site address.

  • statestring

    (Optional) Site state.

  • citystring

    (Optional) Site city.

  • countrystring

  • zipstring

    (Optional) Zip code.

  • primaryContactobject

  • phoneNumberstring

    (Optional) Site phone number for communication.

  • phoneExtensionstring

    (Optional) Site phone extension number.

  • filterCriteriaobject

  • devicesarray

  • resourcesarray

Loading Examples...

Responses

  • idinteger

  • namestring

    Site name.

  • clientIdinteger

  • mspIdinteger

  • parentobject

    (Optional) Parent site. Required if creating a sub-site under a parent site:

  • descriptionstring

    (Optional) Summary of the site.

  • addressstring

    (Optional) Site address.

  • statestring

    (Optional) Site state.

  • citystring

    (Optional) Site city.

  • countrystring

  • zipstring

    (Optional) Zip code.

  • primaryContactobject

  • phoneNumberstring

    (Optional) Site phone number for communication.

  • phoneExtensionstring

    (Optional) Site phone extension number.

  • filterCriteriaobject

  • devicesarray

  • resourcesarray

Loading Examples...

Deletes a site.

Path Parameters

  • siteIdstringrequired

    Site uuid

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

200OK