Xpansiv Facilities API is one of 43 APIs that Xpansiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Facilities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, a quickstart, and an API reference.
This API exposes
10 operations
across 8 paths,
and defines 67 schemas.
It is described by OpenAPI 3.2.0, at version 1.10.
Requests are made against a single base URL, https://www.ms.xpansiv.com/app/api/v1.
The identity and technical contract details declared by the specification.
DggFacilityDetailsFields
object
5 properties
postDggPanelCreate
object
Panel array entry for DGG facility creation (facilityDggFlatCreateOrUpdate.panels). panellocation is optional (unlike panelFlatCreate).
8 properties
7 required
FacilityCreateDggFields
object
10 properties
27 required
FacilityCompleteSuccess
object
Facility application completed successfully.
1 property
1 required
Error
object
Generic error payload when no more specific error schema applies. Implements JsonSerializable so it can be passed directly to APIController::response(). Implem…
2 properties
2 required
postAbpPanelCreate
object
Panel array entry for ABP facility creation (facilityAbpFlatCreateOrUpdate.panels).
9 properties
9 required
StateEligibilityDocument
object
Required document row for a state eligibility entry. Runtime: {@see \Trade\CodeIgniter\models\dto\Documentdto}.
3 properties
3 required
inverterFlatCreate
object
4 properties
4 required
facilityFlatCreateOrUpdate
Standard facility create payload.
uploadFacilityDocumentsResponse
object
Document upload result returned in the API envelope data field.
2 properties
2 required
PaginatedResponseEnvelope
object
Standard API response envelope for paginated endpoints.
ServerError
object
2 required
facilityAddressInput
object
6 properties
5 required
StateEligibilityItem
object
5 properties
3 required
FacilitiesListForAccountList
object
1 property
FacilityStateEligibilitiesList
array
State eligibility rows in the API envelope data field.
ValidationError
object
Error payload for validation failures (400, 422) on request bodies and business rules. For query/path validation, see {@see \Trade\CodeIgniter\dtos\shared\resp…
3 properties
facilityInverterInput
object
5 properties
4 required
FacilityDggFields
object
6 properties
1 required
AuthError
object
2 required
facilityPanelInput
object
9 properties
7 required
Address
object
6 properties
facilityAbpFlatCreateOrUpdate
Illinois ABP facility create payload in legacy flat format. Requires state: IL. Uses postAbpPanelCreate for panels and postAbpInverterCreate for inverters. You…
facilityFlatCreateOrUpdateResponse200
object
Facility create/update success payload returned in the API envelope data field.
2 properties
2 required
AbpFacilityDetailsFields
object
Illinois ABP-specific fields included on facility detail responses.
19 properties
Panel
object
9 properties
StateCertificationInput
object
2 properties
2 required
CreateFacilityStateApplicationRequest
object
Request body for POST /facilities/{facilityid}/stateapplications.
1 property
1 required
facilityCreateOrUpdateCommonProperties
object
Payload format accepted by POST /facilities and PATCH /facilities/{facilityid}. Legacy flat payload keys are still accepted for backwards compatibility and wil…
27 properties
11 required
facilityDggFlatCreateOrUpdate
California DGG facility create payload. Requires dgg: true and state: CA. Uses postDggPanelCreate for panels (not panelFlatCreate).
StateApplicationCreateData
object
State application create success payload returned in the API envelope data field.
2 properties
2 required
AddFacilityStateCertificationRequest
object
Request body for POST /facilities/{facilityid}/statecertifications.
1 property
1 required
FacilityResponse
array
Facility detail rows returned in the API envelope data field (single-facility GET returns one element).
FacilityCompleteError
object
Error payload for POST /facilities/{facilityid}/complete business-rule and validation failures.
3 properties
2 required
facilityCreateOrUpdate
Standard facility create payload in nested format.
facilityRegistryInput
object
Registry fields accepted on create/update. The registry name is derived from the facility state and cannot be set or updated.
1 property
FacilityCreateStandardFields
object
25 properties
26 required
StateCertification
object
3 properties
postAbpInverterCreate
object
Inverter array entry for ABP facility creation (facilityAbpFlatCreateOrUpdate.inverters).
5 properties
5 required
FacilityGetError
object
2 required
Meter
object
17 properties
StateCertificationCreateData
object
State certification create success payload returned in the API envelope data field.
2 properties
2 required
AccessForbiddenError
object
2 required
facilityAbpCreateOrUpdate
ABP facility create payload in nested DTO format.
FacilityGetMissingIdError
object
2 required
FacilityDetails
object
Single facility detail object returned in FacilityResponse.
32 properties
Pagination
object
4 properties
UploadFacilityDocumentsRequest
object
2 properties
1 required
InstallerDemographics
object
Installer workforce demographics for facility create/update requests and ABP detail responses.
14 properties
AbpFacilityDetails
Facility detail for an Illinois Adjustable Block Program (ABP) system. Returned from GET /facilities/{id}?data=all when the facility has an ABP application. Pr…
FacilityListDetails
object
Facility summary returned in the account facilities list.
21 properties
ResponseEnvelope
object
Standard API response envelope. Every response wraps its payload in this structure; the data field contains the operation-specific payload.
5 properties
5 required
Inverter
object
5 properties
FacilityAbpFields
object
Illinois Adjustable Block Program (ABP) fields. Required when creating an ABP facility (address.state is IL and your account is ABP-enabled). See nested panels…
19 properties
facilityFlatCreateOrUpdateCommonProperties
object
Shared JSON properties for standard facility create (facilityFlatCreateOrUpdate), California DGG create (facilityDggFlatCreateOrUpdate), and Illinois ABP creat…
36 properties
Installer
object
6 properties
FacilityDocumentsUploadResult
object
Upload counts and error messages inside {@see FacilityDocumentsUploadSuccess}.
2 properties
2 required
facilityDggCreateOrUpdate
California DGG facility create payload in nested format.
facilityMeterInput
object
14 properties
5 required
FacilityCreateAbpFields
object
50 properties
61 required
Owner
object
6 properties
CompleteFacilityRequest
object
Request body for POST /facilities/{facilityid}/complete.
2 properties
1 required
Registry
object
2 properties
panelFlatCreate
object
8 properties
8 required
facilityInstallerInput
object
6 properties
1 required
facilityOwnerInput
object
6 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Xpansiv publishes across the network.
