IBMS Cloud Responses

Common HTTP Responses

The list below contains common HTTP responses provided by the IBMS Cloud.

Response	Description
200	`OK` - Request completed successfully. Check the output for any errors.
401	`Unauthorised` - You do not have access to the end point.
403	`Forbidden` - AccessToken not provided or invalid.
405	`Method Not Allowed` - The requested resource does not support http method.
500	`Internal server error` - Something went wrong during the request. Contact support if this keeps occuring.

Results

The list below contains common API results

Invalid Request

{
  "Results": [
      {
          "ID": "-1",
          "Result": "Failure",
          "Details": "Request Invalid. Request data not found."
      }
  ]
}

Incorrect Paramaters

{
  "Results": [
    {
        "ID": "-1",
        "Result": "Failure",
        "Details": "You must provide a PurchaseInvoiceID"
    }
  ]
}

Incorrect Data

{
  "Results": [
      {
          "ID": "1",
          "Result": "Failure",
          "Details": "RegionCode cannot be longer than 10 characters\r\n"
      }
  ]
}

Successful Response - PUT/POST/DELETE

{
  "Results": [
      {
          "ID": "77",
          "Result": "Success",
          "Details": "Updated Successfully"
      }
  ]
}

Successful Response - GET

{
    "Results": [
        {
            "ClientID": "2391",
            "Name": "Name",
            "AddressID": "AddressID",
            "AddressDescription": "",
            "AddressName": "AddressName",
            "AddressLine1": "AddressLine1",
            "AddressLine2": "AddressLine2",
            "AddressLine3": "AddressLine3",
            "County": "County",
            "CityTown": "CityTown",
            "Postcode": "Postcode",
            "PhoneNumber": "",
            "Email": "",
            "LegalEntity": "LegalEntity",
            "InvoiceTo": true,
            "DeliverTo": true
        },
        {
            "ClientID": "1004",
            "Name": "Name",
            "AddressID": "AddressID",
            "AddressDescription": "",
            "AddressName": "AddressName",
            "AddressLine1": "AddressLine1",
            "AddressLine2": "AddressLine2",
            "AddressLine3": "AddressLine3",
            "County": "County",
            "CityTown": "CityTown",
            "Postcode": "Postcode",
            "PhoneNumber": "",
            "Email": "",
            "LegalEntity": "LegalEntity",
            "InvoiceTo": true,
            "DeliverTo": true
        }
    ]
}

Successful Response - No Data

{
    "Results": []
}