POST api/oicp/charging/v21/operators/{operatorID}/authorize/start

Request Information

URI Parameters

Name	Description	Type	Additional information
operatorID		string	Required

Body Parameters

KiviCOM.Hubject.Business.Common.Authorization.ERoamingAuthorizeStart.ERoamingAuthorizeStartRequestInfo

Name	Type	Additional information
CPOPartnerSessionID	string	None.
EMPPartnerSessionID	string	None.
EvseID	string	None.
Identification	KiviCOM.Hubject.Business.Common.IdentificationType	None.
OperatorID	string	None.
PartnerProductID	string	None.
SessionID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CPOPartnerSessionID": "sample string 1",
  "EMPPartnerSessionID": "sample string 2",
  "EvseID": "sample string 3",
  "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"
    },
    "RFIDIdentification": {
      "EvcoID": "sample string 1",
      "ExpiryDate": "2025-12-18T05:35:22.3653786+01:00",
      "PrintedNumber": "sample string 3",
      "RFID": "sample string 4",
      "UID": "sample string 5"
    },
    "AuthencationValue": "sample string 1"
  },
  "OperatorID": "sample string 4",
  "PartnerProductID": "sample string 5",
  "SessionID": "sample string 6"
}

text/xml

Sample:

<ERoamingAuthorizeStartRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KiviCOM.Hubject.Business.Common.Authorization.ERoamingAuthorizeStart">
  <CPOPartnerSessionID>sample string 1</CPOPartnerSessionID>
  <EMPPartnerSessionID>sample string 2</EMPPartnerSessionID>
  <EvseID>sample string 3</EvseID>
  <Identification xmlns:d2p1="http://schemas.datacontract.org/2004/07/KiviCOM.Hubject.Business.Common">
    <d2p1:PlugAndChargeIdentification>
      <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
    </d2p1:PlugAndChargeIdentification>
    <d2p1:QRCodeIdentification>
      <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
      <d2p1:HashedPIN>
        <d2p1:Function>sample string 1</d2p1:Function>
        <d2p1:LegacyHashData>
          <d2p1:Function>sample string 1</d2p1:Function>
          <d2p1:Salt>sample string 2</d2p1:Salt>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:LegacyHashData>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:HashedPIN>
      <d2p1:PIN>sample string 2</d2p1:PIN>
    </d2p1:QRCodeIdentification>
    <d2p1:RFIDIdentification>
      <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
      <d2p1:ExpiryDate>2025-12-18T05:35:22.3653786+01:00</d2p1:ExpiryDate>
      <d2p1:PrintedNumber>sample string 3</d2p1:PrintedNumber>
      <d2p1:RFID>sample string 4</d2p1:RFID>
      <d2p1:UID>sample string 5</d2p1:UID>
    </d2p1:RFIDIdentification>
    <d2p1:RFIDMifareFamilyIdentification>
      <d2p1:UID>sample string 1</d2p1:UID>
    </d2p1:RFIDMifareFamilyIdentification>
    <d2p1:RemoteIdentification>
      <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
    </d2p1:RemoteIdentification>
  </Identification>
  <OperatorID>sample string 4</OperatorID>
  <PartnerProductID>sample string 5</PartnerProductID>
  <SessionID>sample string 6</SessionID>
</ERoamingAuthorizeStartRequestInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

KiviCOM.Hubject.Business.Common.Authorization.ERoamingAuthorizeStart.ERoamingAuthorizeStartResponseInfo

Name	Type	Additional information
AuthorizationStatus	string	None.
AuthorizationStopIdentifications	Collection of KiviCOM.Hubject.Business.Common.IdentificationType	None.
CPOPartnerSessionID	string	None.
EMPPartnerSessionID	string	None.
ProviderID	string	None.
SessionID	string	None.
StatusCode	KiviCOM.Hubject.Business.Common.Authorization.ERoamingAuthorizeStart.ERoamingAuthorizeStartResponseInfo+Statuscode	None.

Response Formats

application/json, text/json

Sample:

{
  "AuthorizationStatus": "sample string 1",
  "AuthorizationStopIdentifications": [
    {
      "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"
      },
      "RFIDIdentification": {
        "EvcoID": "sample string 1",
        "ExpiryDate": "2025-12-18T05:35:22.3965988+01:00",
        "PrintedNumber": "sample string 3",
        "RFID": "sample string 4",
        "UID": "sample string 5"
      },
      "AuthencationValue": "sample string 1"
    },
    {
      "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"
      },
      "RFIDIdentification": {
        "EvcoID": "sample string 1",
        "ExpiryDate": "2025-12-18T05:35:22.3965988+01:00",
        "PrintedNumber": "sample string 3",
        "RFID": "sample string 4",
        "UID": "sample string 5"
      },
      "AuthencationValue": "sample string 1"
    }
  ],
  "CPOPartnerSessionID": "sample string 2",
  "EMPPartnerSessionID": "sample string 3",
  "ProviderID": "sample string 4",
  "SessionID": "sample string 5",
  "StatusCode": {
    "AdditionalInfo": "sample string 1",
    "Code": "sample string 2",
    "Description": "sample string 3"
  }
}

text/xml

Sample:

<ERoamingAuthorizeStartResponseInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KiviCOM.Hubject.Business.Common.Authorization.ERoamingAuthorizeStart">
  <AuthorizationStatus>sample string 1</AuthorizationStatus>
  <AuthorizationStopIdentifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/KiviCOM.Hubject.Business.Common">
    <d2p1:IdentificationType>
      <d2p1:PlugAndChargeIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
      </d2p1:PlugAndChargeIdentification>
      <d2p1:QRCodeIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
        <d2p1:HashedPIN>
          <d2p1:Function>sample string 1</d2p1:Function>
          <d2p1:LegacyHashData>
            <d2p1:Function>sample string 1</d2p1:Function>
            <d2p1:Salt>sample string 2</d2p1:Salt>
            <d2p1:Value>sample string 3</d2p1:Value>
          </d2p1:LegacyHashData>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:HashedPIN>
        <d2p1:PIN>sample string 2</d2p1:PIN>
      </d2p1:QRCodeIdentification>
      <d2p1:RFIDIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
        <d2p1:ExpiryDate>2025-12-18T05:35:22.3965988+01:00</d2p1:ExpiryDate>
        <d2p1:PrintedNumber>sample string 3</d2p1:PrintedNumber>
        <d2p1:RFID>sample string 4</d2p1:RFID>
        <d2p1:UID>sample string 5</d2p1:UID>
      </d2p1:RFIDIdentification>
      <d2p1:RFIDMifareFamilyIdentification>
        <d2p1:UID>sample string 1</d2p1:UID>
      </d2p1:RFIDMifareFamilyIdentification>
      <d2p1:RemoteIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
      </d2p1:RemoteIdentification>
    </d2p1:IdentificationType>
    <d2p1:IdentificationType>
      <d2p1:PlugAndChargeIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
      </d2p1:PlugAndChargeIdentification>
      <d2p1:QRCodeIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
        <d2p1:HashedPIN>
          <d2p1:Function>sample string 1</d2p1:Function>
          <d2p1:LegacyHashData>
            <d2p1:Function>sample string 1</d2p1:Function>
            <d2p1:Salt>sample string 2</d2p1:Salt>
            <d2p1:Value>sample string 3</d2p1:Value>
          </d2p1:LegacyHashData>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:HashedPIN>
        <d2p1:PIN>sample string 2</d2p1:PIN>
      </d2p1:QRCodeIdentification>
      <d2p1:RFIDIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
        <d2p1:ExpiryDate>2025-12-18T05:35:22.3965988+01:00</d2p1:ExpiryDate>
        <d2p1:PrintedNumber>sample string 3</d2p1:PrintedNumber>
        <d2p1:RFID>sample string 4</d2p1:RFID>
        <d2p1:UID>sample string 5</d2p1:UID>
      </d2p1:RFIDIdentification>
      <d2p1:RFIDMifareFamilyIdentification>
        <d2p1:UID>sample string 1</d2p1:UID>
      </d2p1:RFIDMifareFamilyIdentification>
      <d2p1:RemoteIdentification>
        <d2p1:EvcoID>sample string 1</d2p1:EvcoID>
      </d2p1:RemoteIdentification>
    </d2p1:IdentificationType>
  </AuthorizationStopIdentifications>
  <CPOPartnerSessionID>sample string 2</CPOPartnerSessionID>
  <EMPPartnerSessionID>sample string 3</EMPPartnerSessionID>
  <ProviderID>sample string 4</ProviderID>
  <SessionID>sample string 5</SessionID>
  <StatusCode>
    <AdditionalInfo>sample string 1</AdditionalInfo>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
  </StatusCode>
</ERoamingAuthorizeStartResponseInfo>