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/SubscribersHTTP Response Codes
| HTTP code | Status | Description |
|---|---|---|
| 200 | OK | The request was successful |
| 201 | Created | The object was successfully created |
| 202 | Accepted | The request was accepted and will be processed |
| 204 | No content | The object was successfully updated or deleted |
| 400 | Bad request | Request is invalid. Check the error code in JSON |
| 401 | Unauthorized | You have not been authenticated. Make sure the provided api-key is correct |
| 402 | Payment | Required Make sure you're account is activated and that you've sufficient credits |
| 403 | Forbidden | You do not have the rights to access the resource |
| 404 | Not Found | Make sure your calling an existing endpoint and that the parameters (object id etc.) in the path are correct |
| 405 | Method Not Allowed | The verb you're using is not allowed for this endpoint. Make sure you're using the correct method (GET, POST, PUT, DELETE) |
| 406 | Not Acceptable | The 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 code | Failure text | description |
|---|---|---|
| 8100 | Mandatory field not given. | The mandatory field within the subscriber packet is missing |
| 8200 | Value '{1}' is none of the Multi-select values [{2} | You attempt to enter none available values into a multiple choice field. |
| 8300 | Value '{1}' is not {2} | You attempt to enter data of the wrong type, e.g. letter instead of integer |
| 8400 | Value '{1}' is not within the range from {2} to {3} | Value is not within the correct range |
| 8500 | Value '{1}' does not match regular expression '{2}' | Value does not match the regular expression |
| 8600 | Value '{1}' exceeds the maximum length of {2} | Value you want to enter is too long |
| 9001 | Person group with id {0} | does not exist This person group is not available |
| 880001001 | DoubleEmail | This email address already exists in this project |
| 9002 | Unexisting MultiSelect Value: {0} | Multiple choice field is not available |
| 8801 | Interests are empty | No interests are indicated. If the subscriber data do not consist of any interests you have to transmit at least 0. |
| 8700 | Interests;Wrong InterestID - {0}. | Transmitted interest is not available xxxx unexpected error Error is not definable. Please contact the support team |
| 400x | Fault Condition Array or missing Condition Array | WHERE Condition has not been indicated for Update or Delete |
| 9005 | Provided interest for deletion does not exists: '{0}'. | The interest for deletion does not exist. |
| 9006 | Provided interest for insertion already exists: '{0}' | The interest entered is already available on the subscriber data. |
| 9007 | You must not delete all existing interests on subscriber | You attempted to delete all interests on the subscriber. |
| 9009 | One or more mandatory fields are empty | One or more mandatory field are empty |
| 9010 | Subscriber does not exist! | Subscriber does not exist (for deletion or update) |
| 880001002 | BlackList | The email address is on the blacklist |
| 9011 | Email Address Not Provided | You missed to indicate the email address |
| 9901 | Authentication Error | There was an error on registration for the web service |
| 9989 | Invalid or not supported XML format | Error in XML package |
| 9919 | Server Error | Please contact our support team |
| 9100 | MultiSelectField sent Error | Not existing multi-select field value sent |
Updated 10 months ago
