Set the tenant's OCPI publishing settings

Path parameters

• tenant_idintegerRequired

Headers

• idempotency-keystringRequired

Request body

• publishbooleanRequired
  Publish this tenant's locations and tariffs over OCPI. Off by default; refused (409 ocpi_tenant_private) for a tenant Ivora keeps private.
• display_namestring | null
  The operator name partners show (Location operator and owner). Required to publish.
  1–100 characters
• websitestring | null
  The operator's https website, in Location operator and owner.
  Up to 255 characters · Pattern ^https://[^\s/@]+(/\S*)?$
• time_zonestring | null
  IANA zone, such as America/Los_Angeles, for locations without one. Without either, a location is not published.
  Up to 64 characters · Pattern ^[A-Za-z_]+(/[A-Za-z0-9_+\-]+)+$
• connector_defaultsobject | null
  Connector facts for connectors the charging core has none for; unset ones are a North American Level 2 J1772 cable, 240 V and 32 A.
  Child attributes

  • standardenum | null
    OCPI 2.2.1 ConnectorType.
    One of CHADEMO, CHAOJI, DOMESTIC_A, DOMESTIC_B, DOMESTIC_C, DOMESTIC_D, DOMESTIC_E, DOMESTIC_F, DOMESTIC_G, DOMESTIC_H, DOMESTIC_I, DOMESTIC_J, DOMESTIC_K, DOMESTIC_L, DOMESTIC_M, DOMESTIC_N, DOMESTIC_O, GBT_AC, GBT_DC, IEC_60309_2_single_16, IEC_60309_2_three_16, IEC_60309_2_three_32, IEC_60309_2_three_64, IEC_62196_T1, IEC_62196_T1_COMBO, IEC_62196_T2, IEC_62196_T2_COMBO, IEC_62196_T3A, IEC_62196_T3C, NEMA_10_30, NEMA_10_50, NEMA_14_30, NEMA_14_50, NEMA_5_20, NEMA_6_30, NEMA_6_50, PANTOGRAPH_BOTTOM_UP, PANTOGRAPH_TOP_DOWN, TESLA_R, TESLA_S
  • formatenum | null
    One of CABLE, SOCKET
  • power_typeenum | null
    One of AC_1_PHASE, AC_2_PHASE, AC_2_PHASE_SPLIT, AC_3_PHASE, DC
  • max_voltageinteger | null
    Volts.
    Minimum 1 · Maximum 2000
  • max_amperageinteger | null
    Amperes.
    Minimum 1 · Maximum 2000
• excluded_location_idsarray of integer
  Location IDs never published.
• own_partyobject | null
  Your own OCPI party. Used only once Ivora staff approved it (own_party.status approved); until then, and with null, locations publish under Ivora's shared party US*IVR with your display_name as operator.
  Child attributes

  • country_codestringRequired
    ISO 3166 alpha-2 country of the registry that issued the party ID, such as US.
    Pattern ^[A-Z]{2}$
  • party_idstringRequired
    The party ID the registry issued: 3 capital letters or digits.
    Pattern ^[A-Z0-9]{3}$

Returns · 200

• tenant_idintegerRequired
• publishbooleanRequired
  The tenant's choice.
• privatebooleanRequired
  Ivora keeps this tenant private: never published, whatever publish says.
• publishedbooleanRequired
  Whether partners receive this tenant's locations and tariffs now: publish, not private, with a display_name. Only where this environment serves OCPI (versions_url not null).
• display_namestring | nullRequired
• websitestring | nullRequired
• time_zonestring | nullRequired
• connector_defaultsConnectorDefaultsRequired
  Child attributes

  • standardstringRequired
  • formatstringRequired
  • power_typestringRequired
  • max_voltageintegerRequired
    Volts.
  • max_amperageintegerRequired
    Amperes.
• excluded_location_idsarray of integerRequired
• own_partyobject | nullRequired
  The party the tenant requested, if any, and whether it is approved.
  Child attributes

  • country_codestringRequired
  • party_idstringRequired
  • statusenumRequired
    approved: Ivora staff approved this pair and locations publish under it. pending_approval: locations publish under USIVR until staff approve it. rejected: staff could not confirm you hold it (rejection_note says why); locations publish under USIVR.
    One of approved, pending_approval, rejected
  • rejection_notestring | nullRequired
    Why Ivora staff rejected the pair, while status is rejected; else null.
• partyOcpiPartyRequired
  Child attributes

  • country_codestringRequired
  • party_idstringRequired
  • sharedbooleanRequired
    true: Ivora's shared party US*IVR.
• versions_urlstring | nullRequired
  The OCPI versions endpoint partners call in this environment; null where it serves no OCPI.
• updated_bystring | nullRequired
  Who last wrote these settings (user:, key: or staff); null for the defaults.
• updated_atstring | nullRequired

Errors