REST API: Key Concepts

Learn the key concepts on mission‹one› REST API

Here is everything you need to understand before starting using the API.

Endpoints

The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, and DELETE methods dictate how your interact with the objects available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.

https://CloudApi.mission-one.de/Rest/Subscribers

HTTP Response Codes

HTTP codeStatusDescription
200OKThe request was successful
201CreatedThe object was successfully created
202AcceptedThe request was accepted and will be processed
204No contentThe object was successfully updated or deleted
400Bad requestRequest is invalid. Check the error code in JSON
401UnauthorizedYou have not been authenticated. Make sure the provided api-key is correct
402PaymentRequired Make sure you're account is activated and that you've sufficient credits
403ForbiddenYou do not have the rights to access the resource
404Not FoundMake sure your calling an existing endpoint and that the parameters (object id etc.) in the path are correct
405Method Not AllowedThe verb you're using is not allowed for this endpoint. Make sure you're using the correct method (GET, POST, PUT, DELETE)
406Not AcceptableThe value of contentType for PUT or POST request in request headers is not application/json. Make sure the value is application/json only and not empty

Error Codes

Please find bellow the codes returned in the JSON body in case of an error.

Failure codeFailure textdescription
8100Mandatory field not given.The mandatory field within the subscriber packet is missing
8200Value '{1}' is none of the Multi-select values [{2}You attempt to enter none available values into a multiple choice field.
8300Value '{1}' is not {2}You attempt to enter data of the wrong type, e.g. letter instead of integer
8400Value '{1}' is not within the range from {2} to {3}Value is not within the correct range
8500Value '{1}' does not match regular expression '{2}'Value does not match the regular expression
8600Value '{1}' exceeds the maximum length of {2}Value you want to enter is too long
9001Person group with id {0}does not exist This person group is not available
880001001DoubleEmailThis email address already exists in this project
9002Unexisting MultiSelect Value: {0}Multiple choice field is not available
8801Interests are emptyNo interests are indicated. If the subscriber data do not consist of any interests you have to transmit at least 0.
8700Interests;Wrong InterestID - {0}.Transmitted interest is not available xxxx unexpected error Error is not definable. Please contact the support team
400xFault Condition Array or missing Condition ArrayWHERE Condition has not been indicated for Update or Delete
9005Provided interest for deletion does not exists: '{0}'.The interest for deletion does not exist.
9006Provided interest for insertion already exists: '{0}'The interest entered is already available on the subscriber data.
9007You must not delete all existing interests on subscriberYou attempted to delete all interests on the subscriber.
9009One or more mandatory fields are emptyOne or more mandatory field are empty
9010Subscriber does not exist!Subscriber does not exist (for deletion or update)
880001002BlackListThe email address is on the blacklist
9011Email Address Not ProvidedYou missed to indicate the email address
9901Authentication ErrorThere was an error on registration for the web service
9989Invalid or not supported XML formatError in XML package
9919Server ErrorPlease contact our support team
9100MultiSelectField sent ErrorNot existing multi-select field value sent