POST /property/post

General Rules

Through a structured JSON, a property can be imported into Mapaprop.

• You must have a Mapaprop account.
• You must have at least 1 image.
• Images must be available at a URL.
• Certain fields are required.
• Upon certain failures, the import is rolled back.
• Regarding images:
  • If there is more than one image, they are processed in ordered list.
  • If at least one image can be fetched, the import is processed.
  • If all images fail, the import is cancelled.
  • The first image in the list will always be the mainImage.
• You can set whether the property is published via the published = true field.
• You must know the branchId. The customerId is derived automatically from the authentication token (any value sent in the body is ignored for security reasons).

This service will import property JSON to Mapaprop.

Resource URL

https://property-api.mapaprop.com/property/post

Sample code

POST /property/post
Host: property-api.mapaprop.com
Content-Type: application/json
Authorization: Bearer {access_token}

The request body is the property JSON (see "Complete JSON model"). The customerId is derived from the authentication token: if included in the body, it is ignored and replaced with the one from the token.

The object you send

The required fields, the complete JSON model and the internals of location, images and attributes are in The property JSON object. They are documented once, there.

Response

The import is asynchronous. The endpoint starts background processing and responds immediately with the execution identifier (executionArn), which is then used to query the status via GET /property/get/status/machine/{executionArn}.

Sample response

{
  "message": "Property creation started",
  "executionArn": "arn:aws:states:us-east-1:000000000000:execution:PropertyWorkflow:Property-1717500000000"
}

Errors

Validation errors for required fields (Missing required field: {field}, Invalid type for {field}: expected {type}) occur during asynchronous processing and are reported when querying the execution status.