Connection

{
  "urls": {
    "download_from_url": "https://staircase.co/html-is-downloaded-from-here",
    "upload_to_url": "https://staircase.co/pdf-is-upload-to-here"
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": "Domain name could not be validated."
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "urls": {
    "download_from_url": "https://staircase.co/xml-is-downloaded-from-here",
    "upload_to_url": "https://staircase.co/json-is-uploaded-here"
  },
  "configuration": {
    "attribute_prefix": "__"
  },
  "product_configuration_id": "345a814d-432e-4801-96b4-74dc03ef1047"
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "<root><company location='US'>Staircase</company></root>",
  "configuration": {
    "attribute_prefix": "__"
  },
  "product_configuration_id": "345a814d-432e-4801-96b4-74dc03ef1047"
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "<root><people><name>John</name></people><random>Nothing</random></root>",
  "configuration": {
    "force_values_into_array": [
      "people"
    ]
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": "\"\" is less than 1 character."
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": "Domain name could not be validated."
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "urls": {
    "download_from_url": "https://staircase.co/json-is-downloaded-from-here",
    "upload_to_url": "https://staircase.co/xml-is-uploaded-here"
  },
  "configuration": {
    "wrapper": "my_wrapper",
    "attribute_prefix": "__"
  },
  "product_configuration_id": "21194609-9634-40a3-a044-979682e58a37"
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "{\"key_1\": \"value_1\"}",
  "product_configuration_id": "345a814d-432e-4801-96b4-74dc03ef1047"
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "{\"people\": [{\"name\": \"John\", \"age\": 30}, {\"name\": \"Jane\", \"age\": 25}, {\"name\": \"Jack\", \"age\": 40}]}",
  "configuration": {
    "array_enumeration": {
      "sequence_start": 0,
      "attribute_name": "ItemIndex"
    }
  }
}

Transformation was successful.

{
  "transformed_data": "<root><people ItemIndex=\"0\"><name>John</name><age>30</age></people><people ItemIndex=\"1\"><name>Jane</name><age>25</age></people><people ItemIndex=\"2\"><name>Jack</name><age>40</age></people></root>"
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "urls": {
    "download_from_url": "https://staircase.co/html-is-downloaded-from-here",
    "upload_to_url": "https://staircase.co/json-is-uploaded-here"
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "<html><body><h1>Staircase</h1></body></html>",
  "product_configuration_id": "345a814d-432e-4801-96b4-74dc03ef1047"
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "urls": {
    "download_from_url": "https://staircase.co/text-is-downloaded-from-here",
    "upload_to_url": "https://staircase.co/json-is-uploaded-here"
  },
  "template_name": "my_special_template",
  "multipart_boundary_header": "----------ieoau._._+2_8_GoodLuck8.3-ds0d0J0S0Kl234324jfLdsjfdAuaoei-----"
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "company: Staircase\ncountry: US\n",
  "template_name": "my_special_template",
  "multipart_boundary_header": "----------ieoau._._+2_8_GoodLuck8.3-ds0d0J0S0Kl234324jfLdsjfdAuaoei-----",
  "product_configuration_id": "605d8623-262f-4d64-a490-4963d73db8f0"
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "urls": {
    "download_from_url": "https://staircase.co/csv-is-downloaded-from-here",
    "upload_to_url": "https://staircase.co/csv-is-uploaded-here"
  },
  "configuration": {
    "delimiter": ";"
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "data": "h1,h2,h3\nr1v1,r1v2,r1v3\nr2v1,r2v2,r2v3",
  "configuration": {
    "column_types": [
      {
        "column_name": "h1"
      },
      {
        "column_type": "string"
      }
    ]
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

{
  "transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
  "callback_url": "https://watch.staircaseapi.com/callback-listener/tok89782uomvc2nuyYBw",
  "urls": {
    "download_from_url": "https://staircase.co/csv-is-downloaded-from-here"
  },
  "configuration": {
    "delimiter": "|",
    "column_types": [
      {
        "column_name": "LoanNumber",
        "column_type": "integer"
      },
      {
        "column_name": "AAndHFlagChangeById",
        "column_type": "string"
      },
      {
        "column_name": "AccelerationAmount",
        "column_type": "float"
      },
      {
        "column_name": "AccelerationReasonCode",
        "column_type": "float"
      }
    ]
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

{
  "template_name": "my_special_template",
  "template_content": "my_template_content"
}

Template was created successfully

{
  "201 Response Example": {
    "value": {
      "template_name": "my_special_template"
    }
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

Retrieved all Transformation Templates

{
  "templates": [],
  "page": {
    "count": 2,
    "next_token": "cGs9VEVNUExBVEUlMjNteV90ZW1wbGF0ZV8yJnNrPVRFTVBMQVRFJTIzbXlfdGVtcGxhdGVfMg=="
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

Retrieved all Transformation Templates

{
  "template_name": "my_special_template",
  "template_content": "template content"
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

{
  "template_content": "my_template_content"
}

Template was updated successfully

{
  "200 Response Example": {
    "message": "The template `template_name` has been updated successfully."
  }
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}

The template was deleted successfully

{
  "message": "The template `my_special_template` has been deleted successfully."
}

Bad request syntax. Request payload does not exist or malformed.

{
  "error": {
    "message": "Bad Request",
    "reason": [
      "\"\" is less than 1 character."
    ]
  }
}

Request is forbidden, API key is not valid

{
  "message": "Your API key is not valid, please refresh it."
}

Resource not found. Resource you were looking for was not found.

{
  "error": {
    "message": "Not Found",
    "reason": "Nothing matches the given URI."
  }
}

A 422 status code occurs when a request is well-formed, however, due to semantic errors it is unable to be processed.

{
  "error": {
    "message": "Unprocessable entity.",
    "reason": {
      "remote": "[422, error_message]"
    }
  }
}