Acquiring A Process Token

INTRODUCTION

Allows the user or 3rd party apps to make changes and initiate program processes that require a specific process token.

OVERVIEW

Process Tokens can only be used once and expires after an hour (60 minutes).

Example of saving 3 times:

REQUEST SAVE TOKEN > SAVE OPERATION > REQUEST SAVE TOKEN > SAVE OPERATION > REQUEST SAVE TOKEN > SAVE OPERATION

PROPERTIES

  • REQUEST:
    • portalID – program group
    • portID – the portal type
    • intGID – ikonomikal id
    • sessID – session id
    • subsID – subscribers’ database id
    • userID – registered email address
    • timeOffSet –¬†adjustment to the browsers’ date and time
    • pgProcTkn – process token to request
      • procID – process token id
      • prgInf – program to request
        • pMODL – program group
        • pPRGM – program code
        • pPRGDSC – program description
  • RESPONSE:
    • rspChr
      • rspID – response id (a zero(0) response is a successful response)
      • rspMsg – error message
      • rspChr – error message parameters

ENDPOINT

https://sc-api.ikonomikal.com/bcss_wbcl_wa_sc/api/O1_getSCPrgPrcCheckTkn

HTTP VERB

POST

HEADERS

Content-Type: application/json

REQUEST

{"portalID":"","portID":0,"intGID":"","sessID":"","subsID":"","userID":"","timeOffSet":0,pgProgTkn:{"procID":0,"prgInf":{"pMODL":"","pPRGM":"","pPRGDSC":""}}}

RESPONSE

{"rspID": 0,"rspMsg": "","rspChr": []}


EXAMPLE

REQUEST:

{"pgProcTkn":{"procID":0,"prgInf":{"pMODL":"SS","pPRGM":"SS07","pPRGDSC":"Department Profile"}},"portalID":"","portID":0,"subsID":"2000001","intGID":"4350AABE-9008-4E5F-9121-8471DD6868C6","userID":"ikotestmail@yahoo.com","sessID":"50F235E2-AECF-423A-8E23-8545B9741B71","timeOffSet":-180}

RESPONSE:

{"rspID": 0,"rspMsg": "","rspChr": []}