OpCode H: Retrieve a list of AttendeeTypes
OpCode H: Retrieve a list of AttendeeTypes
This opcode is used to retrieve a list of Attendee Types defined in the system.
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. |
Return Outputs
This API returns a result set of Attendee Type information upon successful completion. The result set is structured:
| Column | Type/Size |
|---|---|
| AttendeeTypeKey | Integer |
| Description | Varchar 50 |
Return Outputs
There are no potential error codes for this API call.