Home › API Documentation › Appendixes

Appendixes

Status codes

UGAL returns one of the following status codes to indicate the outcome of a request:

• 200 OK
• 201 Created
• 204 Deleted
• 400 Bad request
• 401 Unauthorized
• 403 Forbidden
• 404 Not found
• 405 Method not allowed
• 500 Internal server error
• 503 Service unavailable

Error codes

For 4xx (client errors) and 5xx (server errors) status codes, a description of the error is returned in the body of the response. For example:

// Status: 400 Bad Request
<errors>
    <error>400.906 - User name must be provided</error>
    <error>400.908 - User email must be a valid email address</error>
</errors>

The following error codes and description are used:

400 status code

• 400.000 - Bad request
• 400.100 - Content data missing or invalid
• 400.200 - Catalog id invalid
• 400.201 - Product id invalid
• 400.202 - Item reference invalid
• 400.203 - Item inventory invalid
• 400.204 - Price amount invalid
• 400.205 - Order id invalid
• 400.206 - Order status invalid
• 400.207 - Order payStatus invalid
• 400.208 - Price quantity invalid
• 400.209 - Pricelist invalid
• 400.210 - Nominal price not present
• 400.211 - Duplicate price specification found
• 400.212 - Order attachment id is not valid
• 400.213 - Order attachment title cannot be empty
• 400.214 - Order attachment date is not valid
• 400.215 - Order attachment type is not valid
• 400.216 - Order attachment provider cannot be empty
• 400.217 - Order attachment format is not valid
• 400.218 - Order attachment URL is not valid
• 400.900 - Missing or invalid site content posted
• 400.901 - Site name missing
• 400.902 - Site name invalid
• 400.903 - Sitename already taken
• 400.904 - Account name missing
• 400.905 - Site plan must be in {planA,planB,planC}
• 400.906 - User name missing
• 400.907 - User email missing
• 400.908 - User email invalid
• 400.909 - User password missing
• 400.910 - User password less than 4 characters long
• 400.911 - Plan downgrade not supported
• 400.912 - Portfolio(s) must be deleted prior to plan downgrade
• 400.913 - Newsletter must be deleted prior to plan downgrade
• 400.914 - Event calendar(s) must be deleted prior to plan downgrade
• 400.915 - Forum(s) must be deleted prior to plan downgrade
• 400.916 - Product catalog(s) must be deleted prior to plan downgrade
• 400.917 - Shop must be deleted prior to plan downgrade
• 400.918 - Intranet value must be boolean {true,false}
• 400.920 - Trial or trialend site can be updated to active or deleted only
• 400.921 - Active site can be updated to deleted only
• 400.922 - Contact UGAL to reactivate website
• 400.923 - Contact UGAL to change website status
• 400.924 - Charge id invalid

401 status code

• 401.000 - Unauthorized
• 401.100 - Authentication missing
• 401.101 - Authentication failed

403 status code

• 403.000 - Forbidden
• 403.100 - Site trial ended
• 403.101 - Site pastdue

404 status code

• 404.000 - Not found
• 404.100 - Site not found
• 404.101 - Site deleted
• 404.102 - Not a valid site name
• 404.103 - Partner site not found
• 404.104 - API application not found
• 404.200 - Product catalog not found
• 404.201 - Product not found
• 404.202 - Item not found
• 404.203 - Order not found
• 404.204 - Order attachment not found
• 404.900 - Charge not found

405 status code

• 405.000 - Method not allowed

500 status code

• 500.000 - Internal server error

503 status code

• 503.000 - Service unavailable