Zahteve in odgovori končnih točk Admin API delovnega prostora

To je referenca zahtev/odgovorov za vsako končno točko /v2/admin. Overjanje, idempotentnost, omejitve zahtev, ustvarjanje žetonov in pomen obsegov so dokumentirani v Admin API delovnega prostora. Ponovno uporabni tipi polj in primeri so v Shemah in primerih. Vsako vrstico končne točke berite skupaj s Pogodbo odgovorov in napak, ki navaja vsa možna skupna in posebna neuspešna telesa odgovorov.

Skupna pogodba

Vsaka pot se začne z nameščenim izvorom app-api. Delovni prostor se določi izključno iz overjenega žetona; odjemalci ne smejo pošiljati cpoId. Vse dokumentirane vrednosti :...Id poti virov so pozitivna desetiška cela števila. Vsaka zahteva zahteva natanko eno:

Authorization: Bearer <workspace-access-token>

Zahteve, prikazane s telesom JSON, zahtevajo Content-Type: application/json. Vse spremembe zahtevajo Idempotency-Key (POST, PUT, PATCH in DELETE), vključno z POST /v2/admin/reports/send; razen če vrstica navaja drugače, je uspešna vrsta vsebine application/json, datumi JSON so nizi RFC 3339 in števila so števila JSON.

Vsaka zahteva lahko vsebuje X-Request-Id in X-Error-Format: envelope; glejte Pogodba odgovorov in napak. Ti glavi ne spreminjata shem uspešnih odgovorov.

Spodaj uporabljene oznake:

• none pomeni brez telesa zahteve. DELETE, ki dokumentira telo JSON, to telo še vedno zahteva.
• ? označuje neobvezno lastnost ali parameter poizvedbe.
• T | null pomeni, da je lastnost prisotna in dovoljuje null.
• 204 empty pomeni brez telesa odgovora.
• CursorPage<T> pomeni { items: T[], nextCursor: number|string|null }, razen kjer vrstica izrecno imenuje objekt page ali pagination.
• Vsi manjkajoči gnezdeni viri, tudi ID-ji drugih delovnih prostorov, uporabljajo 404 { "error": "Workspace resource not found", "code": "RESOURCE_NOT_FOUND" }, razen če funkcija dokumentira natančnejši spor.

Skupne sheme zahtev

Vhodi delovnega prostora in lokacije

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
}

Vhod upravljanja moči

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
}

Vhodi polnilnic

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]
}

Vhodi poročil

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"
}

Obdobja poročil morajo ustrezati from < to in ne smejo presegati 90 dni. Če so izpuščena, se uporabi zadnjih 90 dni. userId in anonymous=true se izključujeta. Načrtovani izvozi nadoknadijo zamujeno minuto UTC in uporabljajo omejene ponovitve (odmik 5/10 minut, 30-minutni najem zastale rezervacije, trije poskusi).

Vhodi 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 }

Vhodi profilov polnjenja

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 }

Vhodi uporabnikov

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 }

Pri ustvarjanju omejitve mora biti vsaj eno od energyValue ali timeValue večje od nič. E-poštni naslovi se obrežejo in pretvorijo v male črke. UID-ji RFID so sprejeti samo pri zapisovanju in zakriti v bralnih odgovorih.

Povzetek DTO odgovorov

Tabele končnih točk prikazujejo vse ovojnice odgovorov najvišje ravni. To so glavni ponovno uporabni DTO-ji v teh ovojnicah:

Poti seznamov/podrobnosti vračajo objekte šifrantov, da lahko klicatelji odkrijejo veljavne ID-je. Neznana dodana polja obravnavajte kot združljiva s prihodnjimi različicami in razvejite samo po dokumentiranih stabilnih poljih in kodah napak.

Končne točke delovnega prostora

Končne točke lokacij in upravljanja moči

Končne točke polnilnic

Končne točke poročil

Končne točke tarif

TariffAssignment vsebuje id, chargerId, connectorId, varen povzetek tarife/valute, createdAt in updatedAt.

Končne točke profilov polnjenja

ProfileAssignment vsebuje ID dodelitve, ID-je polnilnice/priključka in varen povzetek profila. Objekti rezultatov OCPP razkrivajo stabilne podatke zahteve/stanja in nikoli poverilnic.

Končne točke uporabnikov, RFID, dostopa, omejitev in lokalnih uporabnikov

Sistemski uporabnik Tagless je zaščiten pred temi operacijami. Napake e-poštnih povabil vrnejo varno stanje dostave brez razkritja podrobnosti SMTP; klicatelji lahko ponovijo, ko je emailRetryReady true.

Binarni odgovori

Dve skupini končnih točk ob uspehu ne vrneta JSON:

Napake binarnih končnih točk so še vedno JSON.