SS07: Add New

 

OVERVIEW

A process token with a procID value of 1 has to be requested and acquired before this process executes. It can only be used once and expires after an hour (60 minutes).

PROPERTIES

  • REQUEST:
    • prgInf – program to request
      • pMODL – program group
      • pPRGM – program code
      • pPRGDSC – program description
    • saveData
      • modInf
        • mUser – system user that saved last <set to blank>
        • mGroup – system group that saved last <set to blank>
        • mDate – last save date <set to zero(0))
        • mTime – last save date <set to zero(0))
      • f001 – code
      • f002 – description
      • f003 – other description
      • f004 – expense type
      • l001 – code label
      • l002 – description label
      • l003 – other description label
      • l004 – expense type label
      • isRead – is the data in read mode (set to -1)
      • rowId – row id (set to 1)
    • cmdStat – record command type
    • portalID – program group
    • portID – the portal type
    • subsID – subscribers’ database id
    • intGID – ikonomikal id
    • userID – registered email address
    • sessID – session id
    • timeOffSet – adjustment to the browsers’ date and time
  • RESPONSE:
    • parCode – returns an array of code or the “f001” property value. An auto code is generated when the “f001” request value is blank.
    • modInf
      • mUser – system user that saved last
      • mGroup – system group that saved last
      • mDate – last save date
      • mTime – last save date
    • rspChr
      • rspID – response id (a zero(0) response is a successful response)
      • rspMsg – error message
      • rspChr – error message parameters

ENDPOINT

https://ss-api.ikonomikal.com/bcss_wbcl_wa_ss/api/ss_02_ss07_sav

HTTP VERB

POST

HEADERS

Content-Type: application/json

REQUEST

{"prgInf":{"pMODL":"","pPRGM":"","pPRGDSC":""},"saveData":{"modInf":{"mUser":"","mGroup":"","mDate":0,"mTime":0},"f001":"","f002":"","f003":"","f004":0,"l001":"","l002":"","l003":"","l004":"","isRead":-1,"rowId":1},"cmdStat":0,"portalID":"","portID":0,"subsID":"","intGID":"","userID":"","sessID":"","timeOffSet":0}

RESPONSE

{"parCode":[],"modInf":{"mUser":"","mGroup":"","mDate":0,"mTime":0},"rspPrc":{"rspID":0,"rspMsg":"","rspChr":[]}}

EXAMPLE

REQUEST:

{"prgInf":{"pMODL":"SS","pPRGM":"SS07","pPRGDSC":""},"saveData":{"modInf":{"mUser":"","mGroup":"","mDate":0,"mTime":0},"f001":"FIN","f002":"Finance","f003":"Finance","f004":0,"l001":"Code","l002":"Description","l003":"Other Description","l004":"Expense Type","isRead":-1,"rowId":1},"cmdStat":0,"portalID":"","portID":0,"subsID":"2000001","intGID":"4350AABE-9008-4E5F-9121-8471DD6868C6","userID":"ikotestmail@yahoo.com","sessID":"3945C170-0799-4241-82CC-A7DF00B32A35","timeOffSet":-180}

RESPONSE:

{"parCode":["FIN"],"modInf":{"mUser":"API01","mGroup":"FORAPIACCESS01","mDate":20171214,"mTime":170134},"rspPrc":{"rspID":0,"rspMsg":"","rspChr":[]}}