Iarratais agus freagraí críochphointí API Riaracháin Spáis Oibre

Seo an tagairt iarratas/freagra do gach críochphointe /v2/admin. Tá fíordheimhniú, idempotency, teorainneacha ráta, cruthú comharthaí agus brí scóipeanna doiciméadaithe in API Riaracháin Spáis Oibre. Tá cineálacha agus samplaí in-athúsáidte ar leibhéal réimse in Scéimeanna agus samplaí. Léigh gach ró críochphointe in éineacht le Conradh freagraí agus earráidí, a liostaíonn gach corp freagra neamh-ratha comhroinnte agus sonrach atá indéanta.

Conradh coiteann

Tosaíonn gach cosán le bunús imscartha app-api. Tagann an spás oibre ón gcomhartha fíordheimhnithe amháin; ní mór do chliaint gan cpoId a sheoladh. Is slánuimhreacha deachúlacha dearfacha iad gach luach doiciméadaithe cosáin acmhainne :...Id. Tá ceann amháin go díreach de dhíth ar gach iarratas:

Authorization: Bearer <workspace-access-token>

Tá Content-Type: application/json de dhíth ar iarratais a thaispeántar le corp JSON. Tá Idempotency-Key (POST, PUT, PATCH agus DELETE) de dhíth ar gach athrú, POST /v2/admin/reports/send san áireamh; mura ndeir ró a mhalairt, is é application/json cineál ábhair ratha, is teaghráin RFC 3339 iad dátaí JSON agus is uimhreacha JSON iad uimhreacha.

Féadfaidh X-Request-Id agus X-Error-Format: envelope a bheith i ngach iarratas; féach Conradh freagraí agus earráidí. Ní athraíonn na ceanntásca seo scéimeanna ratha.

Nodaireacht a úsáidtear thíos:

• Ciallaíonn none gan corp iarratais. Tá an corp fós de dhíth ar DELETE a dhoiciméadaíonn corp JSON.
• Marcálann ? airí roghnach nó paraiméadar ceiste roghnach.
• Ciallaíonn T | null go bhfuil an t-airí i láthair agus incheadaithe mar null.
• Ciallaíonn 204 empty gan corp freagra.
• Ciallaíonn CursorPage<T> { items: T[], nextCursor: number|string|null }, ach amháin nuair a ainmníonn an ró réad page nó pagination go sainráite.
• Úsáideann gach acmhainn neadaithe atá ar iarraidh, lena n-áirítear aitheantóirí ó spásanna oibre eile, 404 { "error": "Workspace resource not found", "code": "RESOURCE_NOT_FOUND" } mura ndoiciméadaíonn gné coinbhleacht níos sonraí.

Scéimeanna iarratais comhroinnte

Ionchuir spáis oibre agus láithreáin

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
}

Ionchur bainistithe cumhachta

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
}

Ionchuir luchtairí

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

Ionchuir tuairiscí

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

Ní mór do raonta tuairiscí from < to a chomhlíonadh agus ní féidir leo dul thar 90 lá. Nuair a fhágtar ar lár iad, úsáidtear an tréimhse 90 lá is déanaí. Tá userId agus anonymous=true comheisiatach. Déanann easpórtálacha sceidealaithe cúiteamh as nóiméad UTC caillte agus úsáideann siad athiarrachtaí teoranta (moill 5/10 nóiméad, léas éilimh sheanaithe 30 nóiméad, trí iarracht).

Ionchuir taraifí

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 }

Ionchuir próifílí luchtaithe

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 }

Ionchuir úsáideora

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 }

Ní mór ceann amháin ar a laghad de energyValue nó timeValue a bheith níos mó ná náid agus teorainn á cruthú. Baintear spásanna imeallacha de ríomhphoist agus tiontaítear go litreacha beaga iad. Ní ghlactar le UIDanna RFID ach ar scríobh agus folaítear iad i bhfreagraí léite.

Achoimre DTOanna freagraí

Taispeánann táblaí na gcríochphointí gach clúdach freagra barrleibhéil. Seo iad na príomh-DTOanna in-athúsáidte sna clúdaigh sin:

Tugann bealaí liosta/sonraí réada cuardaigh ar ais ionas gur féidir le glaoiteoirí IDanna bailí a aimsiú. Caith le réimsí anaithnide breise mar chomhoiriúnacha le leaganacha amach anseo agus ná brainseáil ach ar réimsí cobhsaí agus cóid earráide dhoiciméadaithe.

Críochphointí spáis oibre

Críochphointí láithreáin agus bainistithe cumhachta

Críochphointí luchtairí

Críochphointí tuairiscí

Críochphointí taraifí

Tá id, chargerId, connectorId, achoimre shábháilte taraife/airgeadra, createdAt agus updatedAt in TariffAssignment.

Críochphointí próifílí luchtaithe

Tá a ID sannacháin, IDanna luchtaire/nascóra agus achoimre shábháilte próifíle in ProfileAssignment. Nochtann réada torthaí OCPP faisnéis chobhsaí iarratais/stádais agus ní nochtann siad dintiúir riamh.

Críochphointí úsáideora, RFID, rochtana, teorann agus úsáideora áitiúil

Tá úsáideoir córais Tagless cosanta ar na hoibríochtaí seo. Tugann teipeanna ríomhphoist cuireadh staid shábháilte seachadta ar ais gan sonraí SMTP a sceitheadh; is féidir le glaoiteoirí athiarracht a dhéanamh nuair atá emailRetryReady fíor.

Freagraí dénártha

Ní thugann dhá ghrúpa críochphointí JSON ar ais ar rath:

Is JSON fós iad earráidí ó chríochphointí dénártha.