POST api/v1/hubject/authorization/api/oicp/charging/v21/providers/{externalId}/authorize-remote/stop

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

string

Required

Body Parameters

OICPAuthorizeRemoteStop
NameDescriptionTypeAdditional information
CPOPartnerSessionID

string

None.

EMPPartnerSessionID

string

None.

EvseID

string

None.

Simulation

boolean

None.

ProviderID

string

None.

SessionID

string

None.

Identification

OICPIdentification

None.

OperatorID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CPOPartnerSessionID": "sample string 1",
  "EMPPartnerSessionID": "sample string 2",
  "EvseID": "sample string 3",
  "Simulation": true,
  "ProviderID": "sample string 6",
  "SessionID": "sample string 7",
  "Identification": {
    "RFIDMifareFamilyIdentification": {
      "UID": "sample string 1"
    },
    "QRCodeIdentification": {
      "EvcoID": "sample string 1",
      "HashedPIN": {
        "Function": "sample string 1",
        "LegacyHashData": {
          "Function": "sample string 1",
          "Salt": "sample string 2",
          "Value": "sample string 3"
        },
        "Value": "sample string 2"
      },
      "PIN": "sample string 2"
    },
    "PlugAndChargeIdentification": {
      "EvcoID": "sample string 1"
    },
    "RemoteIdentification": {
      "EvcoID": "sample string 1",
      "IdUser": "sample string 2"
    },
    "RFIDIdentification": {
      "EvcoID": "sample string 1",
      "ExpiryDate": "2026-02-08T14:10:42Z",
      "PrintedNumber": "sample string 3",
      "RFID": "sample string 4",
      "UID": "sample string 5"
    }
  },
  "OperatorID": "sample string 8"
}

application/xml, text/xml

Sample:
<OICPAuthorizeRemoteStop xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <CPOPartnerSessionID>sample string 1</CPOPartnerSessionID>
  <EMPPartnerSessionID>sample string 2</EMPPartnerSessionID>
  <EvseID>sample string 3</EvseID>
  <Identification>
    <PlugAndChargeIdentification>
      <EvcoID>sample string 1</EvcoID>
    </PlugAndChargeIdentification>
    <QRCodeIdentification>
      <EvcoID>sample string 1</EvcoID>
      <HashedPIN>
        <Function>sample string 1</Function>
        <LegacyHashData>
          <Function>sample string 1</Function>
          <Salt>sample string 2</Salt>
          <Value>sample string 3</Value>
        </LegacyHashData>
        <Value>sample string 2</Value>
      </HashedPIN>
      <PIN>sample string 2</PIN>
    </QRCodeIdentification>
    <RFIDIdentification>
      <EvcoID>sample string 1</EvcoID>
      <ExpiryDate>2026-02-08T15:10:42.2512957+01:00</ExpiryDate>
      <PrintedNumber>sample string 3</PrintedNumber>
      <RFID>sample string 4</RFID>
      <UID>sample string 5</UID>
    </RFIDIdentification>
    <RFIDMifareFamilyIdentification>
      <UID>sample string 1</UID>
    </RFIDMifareFamilyIdentification>
    <RemoteIdentification>
      <EvcoID>sample string 1</EvcoID>
      <IdUser>sample string 2</IdUser>
    </RemoteIdentification>
  </Identification>
  <OperatorID>sample string 8</OperatorID>
  <ProviderID>sample string 6</ProviderID>
  <SessionID>sample string 7</SessionID>
  <Simulation>true</Simulation>
</OICPAuthorizeRemoteStop>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OICPAuthorizeRemoteStop'.

Response Information

Resource Description

OICPResultStatus
NameDescriptionTypeAdditional information
CPOPartnerSessionID

string

None.

EMPPartnerSessionID

string

None.

Result

boolean

None.

SessionID

string

None.

StatusCode

OICPStatusCode

None.

TransactionNumber

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CPOPartnerSessionID": "sample string 1",
  "EMPPartnerSessionID": "sample string 2",
  "Result": true,
  "SessionID": "sample string 4",
  "StatusCode": {
    "AdditionalInfo": "sample string 1",
    "Code": "sample string 2",
    "Description": "sample string 3"
  },
  "TransactionNumber": "sample string 5"
}

application/xml, text/xml

Sample:
<OICPResultStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <CPOPartnerSessionID>sample string 1</CPOPartnerSessionID>
  <EMPPartnerSessionID>sample string 2</EMPPartnerSessionID>
  <Result>true</Result>
  <SessionID>sample string 4</SessionID>
  <StatusCode>
    <AdditionalInfo>sample string 1</AdditionalInfo>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
  </StatusCode>
  <TransactionNumber>sample string 5</TransactionNumber>
</OICPResultStatus>