OpCode X: Retrieve the External API Failure Log
OpCode X: Retrieve the External API Failure Log
This opcode is used to create a user in the VTS system. Both attendees (default) and exhibitor users can be created. If a user with the same External ID already existing ID and Passwords, an error is returned. The L combination, as well as the email address, must be unique and not already be used by another person for this tenant.
Calling The API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50500&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&LookupByExternalUserID={0(default)|1}&{Additional, opcode-specific parameters in name=value format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50500. All other parameters may appear in any sequence.
API Parameter | Type/Size | Req. | Comment |
---|---|---|---|
APIUserAuthCode | Varchar 80 | Y | Your API authorization code as supplied by Notified. |
APIUserCredentials | Varchar 80 | Y | Your API user credentials as supplied by Notified. |
OpCodeList | Varchar 20 | Y | Should include I to invoke this function. |
OutputFormat | Char 1 | N | T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
FromDate | Varchar 10 | N | Beginning date to produce the log from (in MM/DD/YYYY format). |
ToDate | Varchar 10 | N | Ending date to produce the log to (in MM/DD/YYYY format). |
SQLID | Integer | N | The specific API section to return log data for. Pass 50500 for User/Registration calls, 50520 for Buddy List API calls, 50530 for Show Planner API calls, 50550 for Exhibitor and Booth API calls, 50560 for Job API calls, or 0 (default) for all. |
ForHTMLDisplay | Bit (0/1) | N | Specifying 1 will replace < and > with < and > as well as cr/lf with <br> tags for easier HTML display. Default is 0. |
Return Outputs
This API returns a result set of log information upon successful completion. The result set is structured:
Column | Type/Size | Comment |
---|---|---|
ExternalAPIErrorKey | Integer | The unique key value for this log entry. |
ErrorDateTime | ODBC date format |
Date and time in CST the error was logged. (EX: 2009-08-19 12:50:36.403) |
API | Varchar 30 |
The name of the API that this error was generated by. Values are: ExternalAPI – User / registration/ show API. BuddyListAPI – Buddy List API. PlannerAPI – Show Planner API. ExhBoothAPI – Exhibitor and Booth API. |
RequestParams | Text | The parameters sent to the API for this request. |
Response | Text | The response that was generated for this request. |
OutputFormat | Char 1 | The output format of the Response data field. T for text, H for HTTP URL-encoded, or X for XML. |
ExternalAPIErrorKey | Integer | The unique key value for this log entry. |
Potential Error Codes
There are no potential error codes for this API call.