POST api/v1/hubject/emsp/authorization/api/oicp/charging/v21/operators/{operatorID}/authorize/start

Request Information

URI Parameters

NameDescriptionTypeAdditional information
operatorID

string

Required

Body Parameters

OICPAuthorizeRemoteStart
NameDescriptionTypeAdditional information
CPOPartnerSessionID

string

None.

Simulation

boolean

None.

EMPPartnerSessionID

string

None.

EvseID

string

None.

Identification

OICPIdentification

None.

PartnerProductID

string

None.

ProviderID

string

None.

SessionID

string

None.

OperatorID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CPOPartnerSessionID": "sample string 1",
  "Simulation": true,
  "EMPPartnerSessionID": "sample string 3",
  "EvseID": "sample string 4",
  "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:43Z",
      "PrintedNumber": "sample string 3",
      "RFID": "sample string 4",
      "UID": "sample string 5"
    }
  },
  "PartnerProductID": "sample string 5",
  "ProviderID": "sample string 6",
  "SessionID": "sample string 7",
  "OperatorID": "sample string 9"
}

application/xml, text/xml

Sample:
<OICPAuthorizeRemoteStart 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 3</EMPPartnerSessionID>
  <EvseID>sample string 4</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:43.0638027+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 9</OperatorID>
  <PartnerProductID>sample string 5</PartnerProductID>
  <ProviderID>sample string 6</ProviderID>
  <SessionID>sample string 7</SessionID>
  <Simulation>true</Simulation>
</OICPAuthorizeRemoteStart>

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 'OICPAuthorizeRemoteStart'.

Response Information

Resource Description

OICPResultStatusEX
NameDescriptionTypeAdditional information
AuthorizationStatus

string

None.

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:
{
  "AuthorizationStatus": "sample string 1",
  "CPOPartnerSessionID": "sample string 2",
  "EMPPartnerSessionID": "sample string 3",
  "Result": true,
  "SessionID": "sample string 5",
  "StatusCode": {
    "AdditionalInfo": "sample string 1",
    "Code": "sample string 2",
    "Description": "sample string 3"
  },
  "TransactionNumber": "sample string 6"
}

application/xml, text/xml

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