API documentation

This SOAP-based API is deprecated. Please use the REST-based API instead.
Below are the error codes sent back by the API.

100 - Authentication errors

Code Message
101 Incorrect user name or password.
102 Unknown user profile.
103 Invalid account type (a PREMIUM or PLATINUM account is required)
104 Invalid API key.
105 Invalid API key.

200 - Access rights errors

201 Insufficient rights with the specified API key.

300 - Account errors

301 Unknown account login.

400 - Subscription errors

401 Unknown subscription code.

500 - Publication errors

501 Unknown publication ID.
503 Not a private publication.
509 Publication's private URL not renewed.

600 - Subscriber errors

601 Unknown subscriber ID.
602 The subscriber has not been added.
603 The subscriber has not been updated.
604 The subscriber has not been activated.
605 The subscriber has not been deactivated.
606 The subscriber has not been unsubscribed.
607 The subscriber has not been deleted.
608 The subscriber session has not been created.
609 The subscriber session has not been deleted.
610 Unknown subscriber session ID.

700 - Publishing errors

701 Unknown error.
702 Missing CID.
703 Missing attachement
704 Missing Book code.
705 Missing URL.
706 Missing text.
710 Limit of documents per request exceeded..
711 Unknown or forbidden file extension.
713 Unable to reach the URL.
714 Error while downloading.
715 Unable to create the text document.
721 Invalid Category reference.
722 Invalid Format reference.
723 Invalid Language reference.

800 - Subscriber DRM errors

801 The unit subscription has not been added.
802 The unit subscription has not been updated.
803 The unit subscription has not been deleted.
811 The periodic subscription has not been added.
812 The periodic subscription has not been updated.
813 The periodic subscription has not been deleted.
821 The serial subscription has not been added.
822 The serial subscription has not been updated.
823 The serial subscription has not been deleted.

900 - Misc. errors

901 The character string to be searched for cannot be blank.
902 The subscriber login cannot be blank.
903 This subscriber login already exists.
904 Unknown unit subscriber for this publication
905 Unknown subscription period.
906 Unknown subscription series.
907 The publication’s circulation mode cannot be “public”.