Asset Management API

Site Partners

Download Spec

get/asset-management/v1/site-partners

List all site partners

This endpoint retrieves a list of all site partners

limitstring

The maximum number of site partners to return (default 20, maximum 100)

Pattern: ^[0-9][0-9]?$|^100$
Default: "20"

startingAfterstring

The ID of the last site partner in the previous page of results. Results will start after this site partner

Responses

Response examples

A list of site partners.

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "type": "siteHost",
        "network": {
          "id": "string"
        },
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z",
        "siteHost": {
          "name": "string",
          "physicalAddress": {
            "streetNumber": "string",
            "streetName": "string",
            "streetDetails": "string",
            "city": "string",
            "state": "AL",
            "postalCode": "string",
            "countryCode": "US"
          },
          "contactDetails": {
            "phone": "string",
            "email": "string"
          }
        },
        "utility": {
          "name": "string",
          "physicalAddress": {
            "streetNumber": "string",
            "streetName": "string",
            "streetDetails": "string",
            "city": "string",
            "state": "AL",
            "postalCode": "string",
            "countryCode": "US"
          },
          "contactDetails": {
            "phone": "string",
            "email": "string"
          }
        },
        "reportingAgency": {
          "name": "string",
          "physicalAddress": {
            "streetNumber": "string",
            "streetName": "string",
            "streetDetails": "string",
            "city": "string",
            "state": "AL",
            "postalCode": "string",
            "countryCode": "US"
          },
          "contactDetails": {
            "phone": "string",
            "email": "string"
          }
        }
      }
    ]
  }
}

post/asset-management/v1/site-partners

Create a site partner

This endpoint creates a site partner.
This action is not enabled by default. You must request additional permissions to perform this action.

typestring

required

The type of site partner (siteHost or utility or reportingAgency)

Enum: siteHost
utility
reportingAgency

networkstring

The network associated with the site partner

siteHostobject (CreateSiteHostParams)

Details specific to the site host type of site partner

namestring

required

physicalAddressobject (PhysicalAddress)

required

Physical address details

contactDetailsobject

required

utilityobject (CreateUtilityParams)

Details specific to the utility type of site partner

namestring

required

physicalAddressobject (PhysicalAddress)

required

Physical address details

contactDetailsobject

required

reportingAgencyobject (CreateReportingAgencyParams)

Details specific to the reporting agency type of site partner

namestring

required

physicalAddressobject (PhysicalAddress)

required

Physical address details

contactDetailsobject

required

Responses

Request examples

{
  "type": "siteHost",
  "network": "string",
  "siteHost": {
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "contactDetails": {
      "phone": "string",
      "email": "string"
    }
  },
  "utility": {
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "contactDetails": {
      "phone": "string",
      "email": "string"
    }
  },
  "reportingAgency": {
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "contactDetails": {
      "phone": "string",
      "email": "string"
    }
  }
}

Response examples

The site partner was successfully created.

{
  "data": {
    "id": "string",
    "type": "siteHost",
    "network": {
      "id": "string"
    },
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z",
    "siteHost": {
      "name": "string",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "contactDetails": {
        "phone": "string",
        "email": "string"
      }
    },
    "utility": {
      "name": "string",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "contactDetails": {
        "phone": "string",
        "email": "string"
      }
    },
    "reportingAgency": {
      "name": "string",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "contactDetails": {
        "phone": "string",
        "email": "string"
      }
    }
  }
}

patch/asset-management/v1/site-partners/{sitePartnerId}

Update a site partner

This endpoint updates an existing site partner by its ID.
This action is not enabled by default. You must request additional permissions to perform this action.

siteHostobject (UpdateSiteHostParams)

Details specific to the site host type of site partner to be updated

namestring

physicalAddressobject (PhysicalAddress)

Physical address details

contactDetailsobject

utilityobject (UpdateUtilityParams)

Details specific to the utility type of site partner to be updated

namestring

physicalAddressobject (PhysicalAddress)

Physical address details

contactDetailsobject

reportingAgencyobject (UpdateReportingAgencyParams)

Details specific to the reporting agency type of site partner to be updated

namestring

physicalAddressobject (PhysicalAddress)

Physical address details

contactDetailsobject

Responses

Request examples

{
  "siteHost": {
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "contactDetails": {
      "phone": "string",
      "email": "string"
    }
  },
  "utility": {
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "contactDetails": {
      "phone": "string",
      "email": "string"
    }
  },
  "reportingAgency": {
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "contactDetails": {
      "phone": "string",
      "email": "string"
    }
  }
}

Response examples

Site partner successfully updated

{
  "data": {
    "id": "string",
    "type": "siteHost",
    "network": {
      "id": "string"
    },
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z",
    "siteHost": {
      "name": "string",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "contactDetails": {
        "phone": "string",
        "email": "string"
      }
    },
    "utility": {
      "name": "string",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "contactDetails": {
        "phone": "string",
        "email": "string"
      }
    },
    "reportingAgency": {
      "name": "string",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "contactDetails": {
        "phone": "string",
        "email": "string"
      }
    }
  }
}

Was this page helpful?