The Portal SOAP API uses result codes and exception arrays to communicate operation status and errors.
Every operation response includes:
| Field | Type | Description |
|---|---|---|
{Operation}Result | int | Result code (0 = success, non-zero = error) |
exception | ArrayOfString | Array of error messages |
gst | int | GST amount in cents |
chargeExgst | int | Charge excluding GST in cents |
chargeAccount | string | Account charged |
sourceDateTime | string | Timestamp of the response |
| Code | Description |
|---|---|
| 0 | Success - operation completed successfully |
| 1 | General error - check exception array for details |
| 2 | Authentication error - invalid session or account |
| 3 | Validation error - invalid input parameters |
| 4 | Not found - requested resource does not exist |
| 5 | Permission denied - insufficient access rights |
| Error | Cause | Solution |
|---|---|---|
| "Invalid session" | Session has expired or is invalid | Re-authenticate to obtain a new session ID |
| "Account not found" | Account ID is incorrect | Verify your account ID |
| "Access denied" | Account lacks required permissions | Contact support to verify account permissions |
| Error | Cause | Solution |
|---|---|---|
| "Invalid date format" | Date not in expected format | Use YYYY-MM-DD format for dates |
| "Required field missing" | Mandatory parameter not provided | Check WSDL for required fields |
| "Invalid subscription ID" | Subscription does not exist | Verify subscription ID exists |
| Error | Cause | Solution |
|---|---|---|
| "Title not found" | Volume/folio does not exist | Verify the title reference |
| "Application not found" | Application ID invalid | Use a valid application ID |
| "Certificate unavailable" | Certificate cannot be ordered | Check certificate availability |
In addition to application-level errors, the service may return SOAP faults for transport or server errors:
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Internal server error</faultstring>
<detail>
<error>Service temporarily unavailable</error>
</detail>
</soap:Fault>- Check Result Code - Always check the
{Operation}Resultfield first - Parse Exceptions - If result is non-zero, iterate through the
exceptionarray - Handle SOAP Faults - Catch and handle SOAP fault exceptions in your client
- Implement Retry Logic - For transient errors, implement exponential backoff
<NotificationListResponse>
<NotificationListResult>2</NotificationListResult>
<notificationTable/>
<exception>
<string>Invalid session ID</string>
<string>Please re-authenticate</string>
</exception>
<gst>0</gst>
<chargeExgst>0</chargeExgst>
<chargeAccount/>
<sourceDateTime>2024-01-15T10:30:00Z</sourceDateTime>
</NotificationListResponse>If you encounter persistent errors or need assistance troubleshooting, contact: data.services@servictoria.com.au
Include in your support request:
- Your account ID
- The operation being called
- The complete error message
- Timestamp of the error
- Your customer reference (if used)