Problems

This section details individual errors that you might come across while working with the API.

Bad Request#

The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

Status#

400

Contract Not Found#

The HTTP 404 Contract Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested resource was not found. Read the API Documentation for more information.

Status#

404

Request#

GET https://api.gridscale.io/management/v2/contracts/<contract_uuid>/projects/<project_uuid>/prices

Response#

Header:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/problems/contract-not-found",
      "title": "Contract Not Found",
      "status": 404,
      "detail": "The requested resource was not found. Read the API DOC https://my.gridscale.io/docs/management/v2/schema.json for more information.",
      "instance": "/management/v2/contracts/61319f06-2795-4c09-84ff-3cf203edfe3c/projects/9e7f903c-d038-4b92-8f28-6440d08fdc7f/prices",
      "data": {
        "contract_uuid": "61319f06-2795-4c09-84ff-3cf203edfe3c"
      }
    }
  ]
}

Gone Wrong#

The HyperText Transfer Protocol (HTTP) 500 Gone Wrong (better known as Internal Server Error) server error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Status#

500

Invoice Not Found#

The HTTP 404 Invoice Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested resource was not found. Read the API Documentation for more information.

Status#

404

Request#

GET https://api.gridscale.io/management/v2/partner/invoices/<iinvoice_nr>

Response#

Header:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/problems/invoice-not-found",
      "title": "Invoice Not Found",
      "status": 404,
      "detail": "The requested resource was not found. Read the API DOC https://my.gridscale.io/docs/management/v2/schema.json for more information.",
      "instance": "/management/v2/partner/invoices/I-23213213",
      "data": {
        "partner_uuid": "61319f06-2795-4c09-84ff-3cf203edfe3c",
        "invoice_nr": "I-23213213"
      }
    }
  ]
}

Location Not Found#

The HTTP 404 Location Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested resource was not found. Read the API Documentation for more information.

Status#

404

Not Found#

The HTTP 404 Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested resource was not found. Read the API Documentation for more information.

Status#

404

Partner Not Found#

The HTTP 404 Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested Partner was not found or you have no access to read this ressource. Read the API Documentation for more information.

Status#

404

Request#

GET https://api.gridscale.io/management/v2/partner

Response#

Header:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/problems/partner-not-found",
      "title": "Partner Not Found",
      "status": 404,
      "detail": "The requested resource was not found. Read the [API Documentation](https://api.gridscale.io/management/v2/schema.json) for more information.",
      "instance": "/management/v2/partner",
      "data": {
        "partner_uuid": "6a24c68b-6864-472b-870f-4c8215c8341f"
      }
    }
  ]
}

Price List Not Found#

The HTTP 404 Price List Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested PriceList was not found or you have no access to read this ressource. Read the API Documentation for more information.

Status#

404

Request#

GET https://api.gridscale.io/management/v2/pricelists/<priceListUuid>/prices

Response#

Header:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/problems/price-list-not-found",
      "title": "Price List Not Found",
      "status": 404,
      "detail": "The requested resource was not found. Read the API DOC https://api.gridscale.io/management/v2/schema.json for more information.",
      "instance": "/management/v2/pricelists/bd8579eb-51e7-47e4-99a7-e1f8ba7097ff/prices",
      "data": {
        "priceListUuid": "bd8579eb-51e7-47e4-99a7-e1f8ba7097ff"
      }
    }
  ]
}

Project Not Found#

The HTTP 404 Project Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested Project was not found or you have no access to read this ressource. Read the API Documentation for more information.

Status#

404

Request#

GET https://api.gridscale.io/management/contracts/<contract_uuid>/projects/<project_uuid>

Response#

Header:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/problems/project-not-found",
      "title": "Project Not Found",
      "status": 404,
      "detail": "The requested resource was not found. Read the API DOC https://api.gridscale.io/management/v2/schema.json for more information.",
      "instance": "/management/v2/contracts/4138d879-029e-4c8b-ae98-b377ee4aef3e/projects/9e7f903c-d038-4b92-8f28-6440d08fdc7a",
      "data": {
        "contract_uuid": "4138d879-029e-4c8b-ae98-b377ee4aef3e",
        "project_uuid": "9e7f903c-d038-4b92-8f28-6440d08fdc7a"
      }
    }
  ]
}

Payment Method Not Found#

The HTTP 404 Payment Method Not Found client error response code indicates that the server can’t find the requested resource. Links that lead to a 404 page are often called broken or dead links and can be subject to link rot.

A 404 status code does not indicate whether the resource is temporarily or permanently missing.

The requested Payment Method was not found or you have no access to read this ressource. Read the API Documentation for more information.

Status#

404

Request#

DELETE https://api.gridscale.io/management/v2/payment-methods/<paymentMethodUuid>

Response#

Header:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json

Body:

{
    "errors": [
        {
            "type": "https://<api url>/docs/problems/payment-method-not-found",
            "title": "Payment Method Not Found",
            "status": 404,
            "detail": "The requested Payment Method was not found or you have no access to read this ressource.",
            "instance": "/management/v2/payment-methods/d4e5ef43-f1a3-4400-aad6-ca76d40324f3",
            "data": {
                "paymentMethodUuid": "d4e5ef43-f1a3-4400-aad6-ca76d40324f3"
            }
        }
    ]
}

Unauthorized#

The HTTP 401 Unauthorized client error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

You are not allowed to access this ressource

Status#

401

Request#

GET https://api.gridscale.io/management/contracts/<uuid>

Response#

Header:

HTTP/1.1 401 Unauthorized
Content-Type: application/problem+json

Body:

{
    "errors": [
        {
            "type": "https://docs.gridscale.io/schema/problem/unauthorized",
            "title": "Unauthorized",
            "detail": "You are not allowed to access this ressource",
            "status": 401,
            "instance": "/contracts/72d48c00-7473-4199-9f4f-e2af81f37dd8",
            "data": {
                "contract_uuid": "72d48c00-7473-4199-9f4f-e2af81f37dd8"
            }
        }
    ]
}

Validation Error#

The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

Requests with POST or PATCH need payload in JSON format.

Status#

400

Request#

PATCH https://api.gridscale.io/management/contracts/72d48c00-7473-4199-9f4f-e2af81f37dd8
{
    "email": "blablabla",
    "vatid": "fofofo
}

Response#

Header:

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json

Body:

{
    "errors": [
        {
            "type": "https://docs.gridscale.io/schema/problem/validation-exception",
            "title": "Validation Exception",
            "detail": "Your input is not a valid E-Mail-Adress ",
            "status": 400,
            "instance": "/contracts/72d48c00-7473-4199-9f4f-e2af81f37dd8",
            "data": {
                "contract_uuid": "72d48c00-7473-4199-9f4f-e2af81f37dd8",
                "field": "email",
            }
        },
        {
            "type": "https://docs.gridscale.io/schema/problem/validation-exception",
            "title": "Validation Exception",
            "detail": "Your vat-id is not a valid vat-id format.",
            "status": 400,
            "instance": "/contracts/72d48c00-7473-4199-9f4f-e2af81f37dd8",
            "data": {
                "contract_uuid": "72d48c00-7473-4199-9f4f-e2af81f37dd8",
                "field": "vatid",
            }
        }
    ]
}