##Endpoint : /order/create
This section describes how to order at new video on the propertymedia api.
A typical order request would contain the following json:
{
client: <client identifier>,
apiKey: <api key>,
orderidentifier: <order identifier>,
shop: <shop id>,
salesdate: <sales date>,
address: <address>,
zip: <zipcode>,
city: <city>,
description: <description>,
images: [
{
url: <image url>,
description: <image description>
},
{
url: <image url>,
description: <image description>
}
],
Static: {
intro: {
text: <intro description>,
url: <intro image url>
},
outro: {
text: <outro description>,
url: <outro image url>
}
},
callback: <callback url>
}
##The order information supplied here are:
####Used for authentication purposes.
client: The client identifier you received from us.
apiKey: The API key we provided.
####Primarily used for the integration and invoicing of the video.
orderidentifier: A unique identifier for the property. May be a case id.
shop: A unique identifier (optional).
salesdate: The date the property went on sale.
callback: The URL we’ll notify on production completion.
####Used for the video production
address, zip, city: The standard data needed for showing the address in the video.
description: The text being used by our speakers.
images: A collection of images and description of each image that may be used in the video.
Static: Static intro and outro images and text for these. This element is not required to create a video.
A typical request example could be the following:
{
client: "exampleClient",
apiKey: "someApiKeyProvidedByUs",
orderidentifier: "12345678",
shop: "123",
salesdate: "2015-01-01",
address: "Somewhere in the world 42",
zip: 1234,
city: "Somewhere",
description: "This is a description of the video and it should be more than 200 chars long.",
images: [
{
url: "http://picture1.png",
description: "Living room"
},
{
url: "http://picture2.png",
description: "Toilet"
}
],
Static: {
intro: {
text: "Welcome to example client",
url: "http://niceintrobackground.png"
},
outro: {
text: "Thank you for seeing example clients video",
url: "http://niceoutrobackground.png"
}
},
callback: "http://exampleclient.org/myvideoisdone"
}