Požadavky a odpovědi endpointů API pro správu pracovního prostoru

Toto je reference požadavků/odpovědí pro každý endpoint /v2/admin. Ověření, idempotence, limity požadavků, vytváření tokenů a význam rozsahů jsou popsány v API pro správu pracovního prostoru. Opakovaně použitelné typy polí a příklady jsou ve Schématech a příkladech. Každý řádek endpointu čtěte společně s Kontraktem odpovědí a chyb, který uvádí všechna možná sdílená a specifická neúspěšná těla odpovědí.

Společný kontrakt

Každá cesta začíná nasazeným originem app-api. Prostor se odvozuje výhradně z ověřeného tokenu; klienti nesmějí posílat cpoId. Všechny dokumentované hodnoty cest zdrojů :...Id jsou kladná celá desetinná čísla. Každý požadavek potřebuje právě jednu:

Authorization: Bearer <workspace-access-token>

Požadavky uvedené s tělem JSON vyžadují Content-Type: application/json. Všechny změny vyžadují Idempotency-Key (POST, PUT, PATCH a DELETE), včetně POST /v2/admin/reports/send; pokud řádek neuvádí jinak, typ obsahu úspěšné odpovědi je application/json, data JSON jsou řetězce RFC 3339 a čísla jsou čísla JSON.

Každý požadavek může obsahovat X-Request-Id a X-Error-Format: envelope; viz Kontrakt odpovědí a chyb. Tyto hlavičky nemění schémata úspěchu.

Použitá notace:

• none znamená žádné tělo požadavku. DELETE, které dokumentuje tělo JSON, toto tělo stále vyžaduje.
• ? označuje volitelnou vlastnost nebo parametr dotazu.
• T | null znamená, že vlastnost je přítomna a může být null.
• 204 empty znamená žádné tělo odpovědi.
• CursorPage<T> znamená { items: T[], nextCursor: number|string|null }, kromě případů, kdy řádek výslovně uvádí objekt page nebo pagination.
• Všechny nenalezené vnořené zdroje, i ID jiného prostoru, používají 404 { "error": "Workspace resource not found", "code": "RESOURCE_NOT_FOUND" }, pokud funkce neuvádí konkrétnější konflikt.

Sdílená schémata požadavků

Vstupy pracovních prostorů a lokalit

WorkspacePatch = {
  name?: string(1..100), email?: email|null, website?: string|null,
  addressLine1?: string|null, addressLine2?: string|null,
  postalCode?: string|null, city?: string|null, state?: string|null,
  countryId?: positive integer
} // at least one property

SiteInput = {
  name: string(1..255), description?: string|null = null,
  addressLine1?: string|null = null, addressLine2?: string|null = null,
  postalCode?: string|null = null, city?: string|null = null, state?: string|null = null,
  countryId: positive integer, timezoneId: positive integer,
  latitude?: number[-90,90]|null = null, longitude?: number[-180,180]|null = null
}

Vstup řízení výkonu

PowerConfigurationInput = { pools: PowerPoolInput[0..200] }
PowerPoolInput = {
  id?: positive integer|null, name?: string(0..255),
  limit: integer[0,100000000], meterSources?: ExternalMeterInput[0..16],
  children?: (PowerPoolInput | ChargerPoolChild)[0..1000]
}
ChargerPoolChild = { chargepointId: positive integer, priority?: integer[-1000000,1000000] }
ExternalMeterInput = {
  id?: positive integer|null, sourceId?: positive integer|null,
  provider?: "perific", name?: string(0..255), externalId: string(1..80),
  measurementMode?: "available_headroom"|"external_non_ev_load_only"|"total_site_load_including_ev",
  valueMode?: "perific_relative"|"perific_direct"|"perific_meter",
  reserveA?: integer[0,100000], offlineSafeA?: integer[0,100000],
  ttlSeconds?: integer[30,86400], enabled?: boolean
}

Vstupy nabíječky

ChargerCreate = { name: string(1..40), identifier: string(1..40), password?: string(0..40) = "", siteId: positive integer }
ChargerPatch = {
  name?: string(1..40), siteId?: positive integer, invertedRfid?: boolean,
  smartMode?: integer[0,3], automationDisabled?: boolean
} // at least one
ConnectorPatch = {
  connectorFormatId: positive integer, connectorTypeId: positive integer,
  powerTypeId: positive integer, maxVoltage: integer[1,10000],
  maxAmperage: integer[1,10000], maxElectricPower: integer[1,100000000]
}

Vstupy přehledů

ReportFilters = {
  from?: RFC3339, to?: RFC3339, siteId?: positive integer,
  chargerId?: positive integer, userId?: positive integer,
  anonymous?: true|false|1|0, active?: true|false|1|0
}
ReportScheduleInput = {
  enabled: boolean, recipientEmail: email(max 255; may be empty only when disabled), format: "csv"|"pdf",
  sendDay: integer[1,28], sendTime: UTC "HH:mm"
}

Rozsahy přehledů musí splňovat from < to a nesmějí přesáhnout 90 dní. Při vynechání se použije posledních 90 dní. userId a anonymous=true se vzájemně vylučují. Plánované exporty doženou zmeškanou minutu UTC a používají omezené opakování (prodleva 5/10 minut, 30minutový pronájem zastaralého zpracování, tři pokusy).

Vstupy tarifů

TariffInput = {
  name: string(1..64),
  exactly one of currencyId: positive integer, currencyCode: 3 letters, currency: 3 letters,
  biddingZoneId?: positive integer|null, tax?: finite number
}
TariffComponentInput = {
  typeId: positive integer, seasonId: positive integer, priority?: finite number,
  price: finite number, validFromMonth?: finite number, validToMonth?: finite number,
  validFromWeekDay?: finite number, validToWeekDay?: finite number,
  validFromHour?: finite number, validToHour?: finite number
}
TariffAssignmentCreateInput = { tariffId: positive integer, connectorId?: nonnegative integer }
TariffAssignmentUpdateInput = { tariffId: positive integer, connectorId: positive integer }

Vstupy nabíjecích profilů

ChargingProfileInput = {
  label: string(1..40), locationId: positive integer, stackLevel: nonnegative number,
  purposeId: positive integer, kindId: positive integer,
  recurrencyKindId?: positive integer|null, validFrom?: RFC3339|null,
  validTo?: RFC3339|null, startSchedule?: RFC3339|null,
  rateUnitId: positive integer, minChargingRate?: nonnegative number|null
}
ChargingProfileCreate = ChargingProfileInput & { schedule?: SchedulePeriod[0..256] }
SchedulePeriod = { startPeriod: nonnegative number, limit: nonnegative number, numberOfPhases?: positive integer|null }
ChargingScheduleInput = { rateUnitId: positive integer, periods: SchedulePeriod[1..256] }
ProfileAssignmentInput = { profileId: positive integer, connectorId?: nonnegative integer }

Vstupy uživatelů

UserCreate = { email: email(max 255), name: string(1..255) }
InvitationInput = {
  email: email, name?: string|null, rfid?: string|null,
  allChargers?: boolean, chargerIds?: unique positive integer[0..500]
} // chargerIds must be non-empty unless allChargers=true
AccessInput = { allChargers?: boolean, chargerIds?: unique positive integer[0..500] }
LimitCreate = { limitTypeId: positive integer, energyValue?: nonnegative integer = 0, timeValue?: nonnegative integer = 0 }
LimitPatch = { limitTypeId?: positive integer, energyValue?: nonnegative integer, timeValue?: nonnegative integer }

Při vytváření limitu musí být alespoň jedno z energyValue nebo timeValue větší než nula. E-maily se oříznou a převedou na malá písmena. RFID UID se přijímají jen při zápisu a při čtení jsou maskována.

Souhrn DTO odpovědí

Tabulky endpointů uvádějí všechny obálky odpovědí nejvyšší úrovně. Toto jsou hlavní opakovaně použitelné DTO uvnitř těchto obálek:

Referenční objekty vracejí seznamové a detailní routy, aby klienti našli platná ID. Nová neznámá pole berte jako dopředně kompatibilní a větvěte jen podle dokumentovaných stabilních polí a kódů.

Endpointy pracovních prostorů

Endpointy lokalit a řízení výkonu

Endpointy nabíječek

Endpointy přehledů

Endpointy tarifů

TariffAssignment obsahuje id, chargerId, connectorId, bezpečný souhrn tarifu/měny, createdAt a updatedAt.

Endpointy nabíjecích profilů

ProfileAssignment obsahuje ID přiřazení, ID nabíječky/konektoru a bezpečný souhrn profilu. Objekty výsledků OCPP zpřístupňují stabilní informace o požadavku/stavu a nikdy přihlašovací údaje.

Endpointy uživatelů, RFID, přístupu, limitů a místních uživatelů

Systémový uživatel Tagless je před těmito operacemi chráněn. Selhání e-mailových pozvánek vrací bezpečný stav doručení bez odhalení údajů SMTP; volající může opakovat pokus, když je emailRetryReady true.

Binární odpovědi

Dvě skupiny endpointů při úspěchu nevracejí JSON:

Chyby binárních endpointů jsou stále JSON.