Back to top

RESTful API of Copy Bounded Context

Headers

As this API is working with JSON every request must add the following headers:

Accept: application/json

And for requests with body:

Content-Type: application/json

Copy

View copy

View all
GET/copy{?ids,unitId,unitIds,locale,page,itemsPerPage}

Example URI

GET https://listings.spotahome.com/copy?ids=3c2e15d7-ba6e-4995-aa19-a00267ca36dd&unitId=12345&unitIds=12345&locale=es&page=1&itemsPerPage=100
URI Parameters
HideShow
ids
array[string] (optional) Example: 3c2e15d7-ba6e-4995-aa19-a00267ca36dd
unitId
string (optional) Example: 12345
unitIds
array[string] (optional) Example: 12345
locale
string (optional) Example: es
page
number (optional) Example: 1
itemsPerPage
number (optional) Example: 100
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "count": 2,
  "total": 2,
  "_links": {
    "self": {
      "href": "/api/copy?page=1"
    },
    "first": {
      "href": "/api/copy?page=1"
    },
    "last": {
      "href": "/api/copy?page=2"
    },
    "next": {
      "href": "/api/copy?page=1"
    },
    "previous": {
      "href": "/api/copy?page=2"
    }
  },
  "_embedded": {
    "sah:copy": [
      {
        "id": "12345-aaa-cccdd",
        "unitId": "98991",
        "locale": "en",
        "copyContent": {
          "title": "Hello, world!",
          "cardTitle": "Hello, world!",
          "header": "Hello, world!",
          "description": "Hello, world!",
          "videoTranscription": "Hello, world!",
          "whatWeLikedMost": "Hello, world!",
          "thingsToKeepInMind": "Hello, world!",
          "additionalDetails": "Hello, world!",
          "flatmates": "Hello, world!",
          "landlordPolicies": "Hello, world!",
          "transportation": "Hello, world!",
          "neighborhoodDescription": "Hello, world!",
          "neighborhoodVideo": "Hello, world!",
          "importantInformation": "Hello, world!",
          "metaTitle": "Hello, world!",
          "metaDescription": "Hello, world!",
          "landlordDescription": "Hello, world!"
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    },
    "total": {
      "type": "number"
    },
    "_links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "first": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "last": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "next": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "previous": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        }
      },
      "required": [
        "self",
        "first",
        "last"
      ]
    },
    "_embedded": {
      "type": "object",
      "properties": {
        "sah:copy": {
          "type": "array"
        }
      }
    }
  },
  "required": [
    "count",
    "total",
    "_links"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}

Bulk update copy
POST/copy

Example URI

POST https://listings.spotahome.com/copy
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Body
{
  "copies": [
    {
      "unitId": "98991",
      "locale": "en",
      "copyContent": {
        "title": "Hello, world!",
        "cardTitle": "Hello, world!",
        "header": "Hello, world!",
        "description": "Hello, world!",
        "videoTranscription": "Hello, world!",
        "whatWeLikedMost": "Hello, world!",
        "thingsToKeepInMind": "Hello, world!",
        "additionalDetails": "Hello, world!",
        "flatmates": "Hello, world!",
        "landlordPolicies": "Hello, world!",
        "transportation": "Hello, world!",
        "neighborhoodDescription": "Hello, world!",
        "neighborhoodVideo": "Hello, world!",
        "importantInformation": "Hello, world!",
        "metaTitle": "Hello, world!",
        "metaDescription": "Hello, world!",
        "landlordDescription": "Hello, world!"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "copies": {
      "type": "array"
    }
  },
  "required": [
    "copies"
  ]
}
Response  204
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The resource was not found",
  "status": 404,
  "title": "Not Found",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request was well formed but was unable to be followed due to semantic errors",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
  "validationMessages": {
    "field": {
      "stringLength": "The input is less than 6 characters long"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "sec10.html (string, required)"
    },
    "validationMessages": {
      "type": "object",
      "properties": {
        "field": {
          "type": "object",
          "properties": {
            "stringLength": {
              "type": "string"
            }
          },
          "required": [
            "stringLength"
          ]
        }
      },
      "description": "Contains a property for each field that failed validation."
    }
  },
  "required": [
    "detail",
    "status",
    "title"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}

Update partial copy
PATCH/copy/{unitId}

Example URI

PATCH https://listings.spotahome.com/copy/157544
URI Parameters
HideShow
unitId
string (required) Example: 157544
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Body
{
  "unitId": "98991",
  "locale": "en",
  "copyContent": {
    "title": "Hello, world!",
    "cardTitle": "Hello, world!",
    "header": "Hello, world!",
    "description": "Hello, world!",
    "videoTranscription": "Hello, world!",
    "whatWeLikedMost": "Hello, world!",
    "thingsToKeepInMind": "Hello, world!",
    "additionalDetails": "Hello, world!",
    "flatmates": "Hello, world!",
    "landlordPolicies": "Hello, world!",
    "transportation": "Hello, world!",
    "neighborhoodDescription": "Hello, world!",
    "neighborhoodVideo": "Hello, world!",
    "importantInformation": "Hello, world!",
    "metaTitle": "Hello, world!",
    "metaDescription": "Hello, world!",
    "landlordDescription": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "unitId": {
      "type": "string"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "fr",
        "it",
        "de",
        "ar",
        "tr",
        "zh",
        "pl",
        "cs",
        "lv",
        "lt",
        "hu",
        "pt"
      ]
    },
    "copyContent": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "cardTitle": {
          "type": "string"
        },
        "header": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "videoTranscription": {
          "type": "string"
        },
        "whatWeLikedMost": {
          "type": "string"
        },
        "thingsToKeepInMind": {
          "type": "string"
        },
        "additionalDetails": {
          "type": "string"
        },
        "flatmates": {
          "type": "string"
        },
        "landlordPolicies": {
          "type": "string"
        },
        "transportation": {
          "type": "string"
        },
        "neighborhoodDescription": {
          "type": "string"
        },
        "neighborhoodVideo": {
          "type": "string"
        },
        "importantInformation": {
          "type": "string"
        },
        "metaTitle": {
          "type": "string"
        },
        "metaDescription": {
          "type": "string"
        },
        "landlordDescription": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "unitId",
    "locale"
  ]
}
Response  204
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The resource was not found",
  "status": 404,
  "title": "Not Found",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}

Landlord copy endpoint

Get copy
GET/copy/{unitId}{?locale}

Example URI

GET https://listings.spotahome.com/copy/157544?locale=en
URI Parameters
HideShow
unitId
string (required) Example: 157544
locale
string (optional) Example: en
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Response  200
HideShow
Body
{
  "id": "12345-aaa-cccdd",
  "unitId": "98991",
  "locale": "en",
  "copyContent": {
    "title": "Hello, world!",
    "cardTitle": "Hello, world!",
    "header": "Hello, world!",
    "description": "Hello, world!",
    "videoTranscription": "Hello, world!",
    "whatWeLikedMost": "Hello, world!",
    "thingsToKeepInMind": "Hello, world!",
    "additionalDetails": "Hello, world!",
    "flatmates": "Hello, world!",
    "landlordPolicies": "Hello, world!",
    "transportation": "Hello, world!",
    "neighborhoodDescription": "Hello, world!",
    "neighborhoodVideo": "Hello, world!",
    "importantInformation": "Hello, world!",
    "metaTitle": "Hello, world!",
    "metaDescription": "Hello, world!",
    "landlordDescription": "Hello, world!"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "unitId": {
      "type": "string"
    },
    "locale": {
      "enum": [
        "en",
        "es",
        "fr",
        "it",
        "de",
        "ar",
        "tr",
        "zh",
        "pl",
        "cs",
        "lv",
        "lt",
        "hu",
        "pt"
      ]
    },
    "copyContent": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "cardTitle": {
          "type": "string"
        },
        "header": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "videoTranscription": {
          "type": "string"
        },
        "whatWeLikedMost": {
          "type": "string"
        },
        "thingsToKeepInMind": {
          "type": "string"
        },
        "additionalDetails": {
          "type": "string"
        },
        "flatmates": {
          "type": "string"
        },
        "landlordPolicies": {
          "type": "string"
        },
        "transportation": {
          "type": "string"
        },
        "neighborhoodDescription": {
          "type": "string"
        },
        "neighborhoodVideo": {
          "type": "string"
        },
        "importantInformation": {
          "type": "string"
        },
        "metaTitle": {
          "type": "string"
        },
        "metaDescription": {
          "type": "string"
        },
        "landlordDescription": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "id",
    "unitId",
    "locale",
    "copyContent"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Forbidden access",
  "status": 403,
  "title": "Forbidden",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The resource was not found",
  "status": 404,
  "title": "Not Found",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request was well formed but was unable to be followed due to semantic errors",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
  "validationMessages": {
    "field": {
      "stringLength": "The input is less than 6 characters long"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "sec10.html (string, required)"
    },
    "validationMessages": {
      "type": "object",
      "properties": {
        "field": {
          "type": "object",
          "properties": {
            "stringLength": {
              "type": "string"
            }
          },
          "required": [
            "stringLength"
          ]
        }
      },
      "description": "Contains a property for each field that failed validation."
    }
  },
  "required": [
    "detail",
    "status",
    "title"
  ]
}

Update copy
POST/copy/{unitId}

Example URI

POST https://listings.spotahome.com/copy/157544
URI Parameters
HideShow
unitId
string (required) Example: 157544
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Body
{
  "locale": "en",
  "copyContent": {
    "landlordDescription": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "fr",
        "it",
        "de",
        "ar",
        "tr",
        "zh",
        "pl",
        "cs",
        "lv",
        "lt",
        "hu",
        "pt"
      ]
    },
    "copyContent": {
      "type": "object",
      "properties": {
        "landlordDescription": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "locale"
  ]
}
Response  204
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Forbidden access",
  "status": 403,
  "title": "Forbidden",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The resource was not found",
  "status": 404,
  "title": "Not Found",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request was well formed but was unable to be followed due to semantic errors",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
  "validationMessages": {
    "field": {
      "stringLength": "The input is less than 6 characters long"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "sec10.html (string, required)"
    },
    "validationMessages": {
      "type": "object",
      "properties": {
        "field": {
          "type": "object",
          "properties": {
            "stringLength": {
              "type": "string"
            }
          },
          "required": [
            "stringLength"
          ]
        }
      },
      "description": "Contains a property for each field that failed validation."
    }
  },
  "required": [
    "detail",
    "status",
    "title"
  ]
}

Clone copy

Clone copy
POST/copy/clone

Example URI

POST https://listings.spotahome.com/copy/clone
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Body
{
  "sourcePropertyId": "154656",
  "destinationPropertyIds": [
    "123123",
    "56464",
    "45745"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "sourcePropertyId": {
      "type": "string"
    },
    "destinationPropertyIds": {
      "type": "array"
    }
  },
  "required": [
    "sourcePropertyId",
    "destinationPropertyIds"
  ]
}
Response  202
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The resource was not found",
  "status": 404,
  "title": "Not Found",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request was well formed but was unable to be followed due to semantic errors",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
  "validationMessages": {
    "field": {
      "stringLength": "The input is less than 6 characters long"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "sec10.html (string, required)"
    },
    "validationMessages": {
      "type": "object",
      "properties": {
        "field": {
          "type": "object",
          "properties": {
            "stringLength": {
              "type": "string"
            }
          },
          "required": [
            "stringLength"
          ]
        }
      },
      "description": "Contains a property for each field that failed validation."
    }
  },
  "required": [
    "detail",
    "status",
    "title"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}

Neighbourhood Description

Create neighbourhood description

Create new neighbourhood description
POST/neighbourhoods-descriptions

Example URI

POST https://listings.spotahome.com/neighbourhoods-descriptions
Request
HideShow
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Body
{
  "neighbourhoodId": "neighbourhoodId",
  "locale": "en",
  "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "videoUrl": "https://www.youtube.com/watch?v=gn-hfrge3I8"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "neighbourhoodId": {
      "type": "string"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "fr",
        "it",
        "de",
        "ar",
        "tr",
        "zh",
        "pl",
        "cs",
        "lv",
        "lt",
        "hu",
        "pt"
      ]
    },
    "text": {
      "type": "string"
    },
    "videoUrl": {
      "type": "string"
    }
  },
  "required": [
    "neighbourhoodId",
    "locale",
    "text"
  ]
}
Response  201
HideShow
Headers
Location: /neighbourhoods-descriptions/aaaa-bbbb-cccc-dddd
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request could not be understood by the server due to malformed syntax",
  "status": 400,
  "title": "Bad Request",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request could not be completed due to a conflict with the current state of the resource",
  "status": 409,
  "title": "Conflict",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}

Neighbourhood description

View neighbourhood description
GET/neighbourhoods-descriptions/{id}

Example URI

GET https://listings.spotahome.com/neighbourhoods-descriptions/7121b75d-768d-4907-8535-052772efe3cd
URI Parameters
HideShow
id
string (required) Example: 7121b75d-768d-4907-8535-052772efe3cd
Request
HideShow
Headers
Authorization: aa.bb.cc
Response  200
HideShow
Headers
Content-Type: application/hal+json
Body
{
  "neighbourhoodId": "neighbourhoodId",
  "locale": "en",
  "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "videoUrl": "https://www.youtube.com/watch?v=gn-hfrge3I8",
  "_links": {
    "self": {
      "href": "https://monolith.spotahome.com/api/{resource}/{id}"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "neighbourhoodId": {
      "type": "string"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "fr",
        "it",
        "de",
        "ar",
        "tr",
        "zh",
        "pl",
        "cs",
        "lv",
        "lt",
        "hu",
        "pt"
      ]
    },
    "text": {
      "type": "string"
    },
    "videoUrl": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string",
              "description": "The link URI or URI template"
            }
          },
          "required": [
            "href"
          ]
        }
      }
    }
  },
  "required": [
    "neighbourhoodId",
    "locale",
    "text",
    "videoUrl",
    "_links"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request could not be understood by the server due to malformed syntax",
  "status": 400,
  "title": "Bad Request",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Unauthorized user",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "The request could not be completed due to a conflict with the current state of the resource",
  "status": 409,
  "title": "Conflict",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "detail": "Internal Server Error",
  "status": 500,
  "title": "Internal Server Error",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "detail": {
      "type": "string"
    },
    "status": {
      "type": "number"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "detail",
    "status",
    "title",
    "type"
  ]
}

Generated by aglio on 03 Dec 2025