Response Format Examples

This section provides examples of different response formats that the API can return. These examples are useful for understanding how to interpret the data provided by the API.

JSON Format

The most common format used by our API is JSON (JavaScript Object Notation). It is a lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate.

Example:

{
  "status": "success",
  "data": {
    "items": [
      {
        "id": 1,
        "name": "Item 1",
        "description": "This is the first item."
      },
      {
        "id": 2,
        "name": "Item 2",
        "description": "This is the second item."
      }
    ]
  }
}

XML Format

For some legacy systems, we also support XML (eXtensible Markup Language) format. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.

Example:

<response>
  <status>success</status>
  <data>
    <items>
      <item>
        <id>1</id>
        <name>Item 1</name>
        <description>This is the first item.</description>
      </item>
      <item>
        <id>2</id>
        <name>Item 2</name>
        <description>This is the second item.</description>
      </item>
    </items>
  </data>
</response>

For more information on our API, please visit our API Documentation.

Media Content

For visual examples of the response formats, you can check out the following images: