Return Values
Limited Support/End of Life Capabilities
The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.
If you need to request a hotfix or support for these features, please contact Alemba Support
ASM has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common ASM transactions. This section of the documentation deals with the Classic API. For more information on the RESTful Alemba API, see here.
The following is a list of return values that are returned by the API following a transaction request. A return value can signify success, a warning or an error.
Success Code
Success Code | Value |
API_SUCCESS | 0 |
Warning Codes
Warning Code | Value |
API_WARNING_LOOKUP | 1 |
API_WARNING_NOPAGER | 2 |
API_WARNING_NOINTMSG | 4 |
API_WARNING_NOEMAIL | 5 |
API_WARNING_NOSTAKEHOLDERS | 7 |
API_WARNING_ASSETAMBIGUOUS | 10 |
API_WARNING_CUSTOMERAMBIGUOUS | 11 |
API_WARNING_ORGANIZATIONAMBIGUOUS | 12 |
API_WARNING_LOCATIONAMBIGUOUS | 13 |
API_WARNING_CONTRACTAMBIGUOUS | 14 |
API_WARNING_EXTSUPPLIERAMBIGUOUS | 15 |
API_WARNING_OFFICERAMBIGUOUS | 16 |
API_WARNING_INVALIDTRAVERSALDEPTH | 17 |
API_WARNING_INVALIDFREQUENCY | 18 |
API_WARNING_SOURCENOTFOUND | 19 |
API_WARNING_INVALIDLOOKUPFORMAT | 20 |
API_WARNING_LOOKUPREFNOTFOUND | 21 |
API_WARNING_AMBIGUOUS | 25 |
API_WARNING_ATTRIBUTEENTITYNOTSPECIFIED | 26 |
API_WARNING_INVALIDEMAILPRIORITY | 27 |
API_WARNING_TASKENTITY | 28 |
API_WARNING_SYSPARAMSECURITYPROFILE | 29 |
API_WARNING_ASSETPROFILEEXISTS | 30 |
API_WARNING_REQUESTASSETLINKEXISTS | 31 |
API_WARNING_REQUESTASSETLINKDOESNOTEXIST | 32 |
API_WARNING_ASSETPROFILEDOESNOTEXIST | 33 |
API_WARNING_INVALIDDATEFORMAT | 34 |
API_WARNING_PARTITION | 35 |
API_WARNING_AVAILABILITY | 36 |
Error Codes
Error Code | Constant |
API_ERROR | 1000 |
API_ITEM_LOCKED | 1001 |
API_ERROR_LOOKUPCONFIGITEM | 1021 |
API_ERROR_LOOKUPCUSTOMER | 1022 |
API_ERROR_LOOKUPORGANIZATION | 1023 |
API_ERROR_LOOKUPLOCATION | 1024 |
API_ERROR_LOOKUPCONTRACT | 1025 |
API_ERROR_LOOKUPEXTSUPPLIER | 1026 |
API_ERROR_LOOKUPSTENCIL | 1027 |
API_ERROR_LOOKUPOFFICER | 1028 |
API_ERROR_LOOKUPIPGROUP | 1029 |
API_ERROR_LOOKUPCMGROUP | 1030 |
API_ERROR_LOOKUPCALL | 1031 |
API_ERROR_LOOKUPREQUEST | 1032 |
API_ERROR_LOOKUPTASK | 1033 |
API_ERROR_LOOKUPBULLETIN | 1034 |
API_ERROR_LOOKUPKNOWLEDGE | 1035 |
API_ERROR_LOOKUPATTRIBUTE | 1036 |
API_ERROR_LOOKUPSECURITYPROFILE | 1037 |
API_ERROR_LOOKUPKNOWLEDGEMAJORTYPE | 1040 |
API_ERROR_LOOKUPSTAKEHOLDER | 1041 |
API_ERROR_QUERY | 1100 |
API_ERROR_LOGINFAIL | 1101 |
API_ERROR_INVALIDID | 1102 |
API_ERROR_NOOFFICERGROUPSPEC | 1103 |
API_ERROR_INVALIDDATABASEID | 1104 |
API_ERROR_UNABLETOCREATEREQUEST | 1110 |
API_ERROR_REQUESTDOESNOTEXIST | 1111 |
API_ERROR_REQUESTLOCKED | 1112 |
API_ERROR_MSGNOCONFIG | 1120 |
API_ERROR_TASKDOESNOTEXIST | 1130 |
API_ERROR_TASKLOCKED | 1131 |
API_ERROR_UNABLETOCREATECALL | 1140 |
API_ERROR_CALLDOESNOTEXIST | 1141 |
API_ERROR_CALLREASONMANDATORY | 1142 |
API_ERROR_CALLLOCKED | 1143 |
API_ERROR_UNABLETOCREATEASSET | 1150 |
API_ERROR_ASSETDOESNOTEXIST | 1151 |
API_ERROR_ASSETALREADYDELETED | 1153 |
API_ERROR_ASSETSALREADYLINKED | 1154 |
API_ERROR_ASSETCONTRACTALREADYLINKED | 1156 |
API_ERROR_ASSETCONTRACTNOTLINKED | 1157 |
API_ERROR_ASSETSTATIC | 1158 |
API_ERROR_UNABLETOCREATECONTRACT | 1160 |
API_ERROR_CONTRACTDOESNOTEXIST | 1161 |
API_ERROR_CONTRACTALREADYDELETED | 1162 |
API_ERROR_UNABLETOCREATECUSTOMER | 1170 |
API_ERROR_CUSTOMERDOESNOTEXIST | 1171 |
API_ERROR_CUSTOMERALREADYDELETED | 1172 |
API_ERROR_UNABLETOCREATEORGANIZATION | 1180 |
API_ERROR_ORGANIZATIONDOESNOTEXIST | 1181 |
API_ERROR_ORGANIZATIONALREADYDELETED | 1182 |
API_ERROR_UNABLETOCREATELOCATION | 1190 |
API_ERROR_LOCATIONDOESNOTEXIST | 1191 |
API_ERROR_LOCATIONALREADYDELETED | 1192 |
API_ERROR_UNABLETOCREATEEXTSUPPLIER | 1200 |
API_ERROR_EXTSUPPLIERDOESNOTEXIST | 1201 |
API_ERROR_EXTSUPPLIERALREADYDELETED | 1202 |
API_ERROR_UNABLETOCREATEBULLETIN | 1210 |
API_ERROR_BULLETINDOESNOTEXIST | 1211 |
API_ERROR_BULLETINALREADYDELETED | 1212 |
API_ERROR_BULLETINNOTDATE | 1214 |
API_ERROR_BULLETINEXPIRESBEFOREACTIVE | 1215 |
API_ERROR_BULLETINLOCKED | 1216 |
API_ERROR_EXECQRYNOTFOUND | 1220 |
API_ERROR_EXECQRYNOCONNDB | 1221 |
API_ERROR_ATTRIBUTENOTFOUND | 1230 |
API_ERROR_ENTITYNOTFOUND | 1231 |
API_ERROR_ATTRIBUTEUNABLEALLOCREF | 1232 |
API_ERROR_ATTRIBUTEFORENITTYNOTFOUND | 1233 |
API_ERROR_UNABLETOCREATEKNOWLEDGE | 1240 |
API_ERROR_KNOWLEDGEDOESNOTEXIST | 1241 |
API_ERROR_KNOWLEDGEALREADYDELETED | 1242 |
API_ERROR_NOOBJECT | 1250 |
API_ERROR_NOFILENAME | 1251 |
API_ERROR_ZEROFILESIZE | 1252 |
API_ERROR_OBJECTCONTAINEDVIRUS | 1253 |
API_ERROR_OBJECTUNABLETOATTACH | 1254 |
API_ERROR_TASKENTITY | 1255 |
API_ERROR_LOOKUPBBPRIORITY | 1260 |
API_ERROR_EMAILPERMISSION | 1261 |
API_ERROR_UNABLETOCREATESTAKEHOLDER | 1262 |
API_ERROR_STAKEHOLDERNOTFOUND | 1263 |
API_ERROR_UNABLETOUPDATESTAKEHOLDER | 1264 |
API_ERROR_STAKEHOLDER_EXISTS | 1265 |
API_ERROR_LOOKUPAGREEMENT | 1266 |
API_ERROR_CALLTAKEACTION | 1267 |
API_ERROR_TASKTAKEACTION | 1268 |
API_ERROR_REQUESTTAKEACTION | 1269 |
API_ERROR_LOOKUPEXTOFFICER | 1270 |
API_ERROR_EXTOFFICERDOESNOTEXIST | 1271 |
API_ERROR_OFFICERCONTRACTALREADYLINKED | 1272 |
API_ERROR_OFFICERCONTRACTNOTLINKED | 1273 |
API_ERROR_PARTITIONING | 1274 |
API_ERROR_REQUESTCIDOESNOTEXIST | 1275 |
API_ERROR_NOLICCHANGE | 1300 |
API_ERROR_NOLICHELP | 1301 |
API_ERROR_NOLICKB | 1302 |
API_ERROR_NOLICATTR | 1303 |
API_ERROR_NOLICEMAIL | 1304 |
API_ERROR_NOTCHANGEOFFICER | 1310 |
API_ERROR_NOTHELPOFFICER | 1311 |
API_ERROR_NOPERMISSION | 1312 |
API_ERROR_TIMESHEETDATEREQUIRED | 1313 |
API_ERROR_TIMESHEETINVALIDDATEFORMAT | 1314 |
API_ERROR_TIMESHEETINVALIDCALL | 1314 |
API_ERROR_TIMESHEETINVALIDTASK | 1315 |
API_ERROR_AVAILABILITY | 1316 |
API_ERROR_AVNOTENABLED | 1317 |