ehouse API Help Page ehouse API documentation

Bearer token request

API	Description
POST Token	Returns a bearer token whcih can be ued to consume the API URI : https://api.ehouse.co.uk/Token

PhotographersV2

API	Description
GET v2/Photographers	Returns a full list of photgrapher details.
GET v2/Photographers/{id}	Returns photographer details for the requested photographer id.

PhotographersV1Api

API	Description
GET v1/Photographers	Returns a full list of photgrapher details.
GET v1/Photographers/{id}	Returns photographer details for the requested photographer id.

KeyInvoiceItemsV2

KeyInvoiceItems Controller,Contains all the APIs relating to information about KeyInvoiceItems which is needed when creating orders.

API	Description
GET v2/KeyInvoiceItems	Returns a detailed list of KeyInvoiceItems
GET v2/KeyInvoiceItems/{id}	Returns details of a selected KeyInvoiceItem

KeyInvoiceItemsV1

KeyInvoiceItems Controller,Contains all the APIs relating to information about KeyInvoiceItems which is needed when creating orders.

API	Description
GET v1/KeyInvoiceItems?branchFavourites={branchFavourites}	Returns a list of KeyInvoiceItems.
GET v1/KeyInvoiceItems/GetDetails?branchFavourites={branchFavourites}	Returns a detailed list of KeyInvoiceItems.
GET v1/KeyInvoiceItems/{id}	Returns a single invoice KeyInvoiceItem.
GET v1/KeyInvoiceItems/{id}/GetDetails	Returns a single invoice KeyInvoiceItem.

AccountV2

Account Controller , Contains all the APIs relating to users of the system.

API	Description
POST v2/Account/ResetPassword	Resets user account password.
POST v2/Account/ChangePassword	Change the user account password.
POST v2/Account/GetAccount	Returns a single user account.
POST v2/Account/GetAccounts	Returns a list of user accounts.
POST v2/Account/Register	Register a new user account.
POST v2/Account/RegisterAndActivate	No documentation available.
POST v2/Account/ForgotPassword	Receive password reset token via email.
POST v2/Account/ForgotUserName	Receive username reminder via email.
POST v2/Account/ActivationTokenRequest	Receive user account activation token via email.
POST v2/Account/UnlockTokenRequest	Receive user account unlock token via email.
POST v2/Account/Activate	Activate user account using an activation token.
POST v2/Account/Unlock	Unlock user account using an unlock token.

AccountV1

Account Controller , Contains all the APIs reating to users of the system.

API	Description
POST v1/Account/ResetPassword	Resets user account password.
POST v1/Account/ChangePassword	Change the user account password.
POST v1/Account/Register	Register a new user account.
POST v1/Account/ForgotPassword	Receive password reset token via email.
POST v1/Account/ForgotUserName	Receive username reminder via email.
POST v1/Account/ActivationTokenRequest	Receive user account activation token via email.
POST v1/Account/UnlockTokenRequest	Receive user account unlock token via email.
POST v1/Account/Activate	Activate user account using an activation token.
POST v1/Account/Unlock	Unlock user account using an unlock token.

WebhooksV1Api

API	Description
GET v1/Webhooks	Get all the webhoooks defined under a particular branch.
GET v1/Webhooks/{notificationCode}	Get a single webhook defined under a particular branch.
POST v1/Webhooks	Setup a webhook to recieve notifications when assets are ready.
DELETE v1/Webhooks/{notificationCode}	Deletes a webhook.
POST v1/Webhooks/GetDummyNotification	This API is to help developers to get dummy notifications during the implementation phase of webhook APIs. You can provide a dummy order number and a the notification code provided in one of your webhook APIs to recieve a dummy notification to the URI provided in the webhook.

OrdersV1Api

Orders controller , Contains all the APIs relating to posting,getting,editing and deleting orders

API	Description
GET v1/Orders?page={page}&pageSize={pageSize}	Returns list of orders belongs to the branch
GET v1/Orders/GetOrderListSummary	Returns a summary of all the orders.
GET v1/Orders/{id}	Returns a single order
POST v1/Orders	Place a new order
PUT v1/Orders/{id}	Edit an order.
DELETE v1/Orders/{id}	Delete an order
GET v1/Orders/{id}/InvoiceItems/{invoiceItemId}	Returns all the invoice items for a single order
GET v1/Orders/{id}/Stills	Returns the url list and url count for all the stills under a specific job
GET v1/Orders/{id}/Floorplans	Returns the a url list and url count for all the floorplans under a specific order
GET v1/Orders/{id}/VirtualTours	Returns virtual tour urls and url count for the order
GET v1/Orders/{id}/Video	Returns video urls and url count for the order
GET v1/Orders/{id}/EPC	Returns EPC report reference number
GET v1/Orders/{id}/Verifications	Returns verification images bundled in a zip file.
GET v1/Orders/{id}/InvoiceItems	Returns all the invoice items for an order
POST v1/Orders/{id}/InvoiceItems	Add extra invoice items to an existing order
PUT v1/Orders/{id}/InvoiceItems/{invoiceItemId}	Edit the quantity of an existing invoice items for a job
DELETE v1/Orders/{id}/InvoiceItems/{invoiceItemId}	Deletes an invoice item from an existing order
GET v1/Orders/{id}/GetAvailablePhotographerBookings	Returns a list of available photographer booking times.
GET v1/Orders/GetAvailablePhotographerBookings?postCode={postCode}&bedrooms={bedrooms}&stills={stills}&elevatedStills={elevatedStills}&virtualTours={virtualTours}&epc={epc}&verification={verification}&video={video}&floorplan={floorplan}	Returns a list of available photographer booking times.
GET v1/Orders/{id}/GetAvailablePhotographerBookingsWithBio	Returns a list of available photographer booking times with their bio details.
POST v1/Orders/{id}/BookPhotographer	Book a photographer
POST v1/Orders/{id}/UnbookPhotographer	Unbook a photographer

Default

API	Description
GET Default/Get?id={id}	No documentation available.
POST api/Default	No documentation available.
PUT api/Default/{id}	No documentation available.
DELETE api/Default/{id}	No documentation available.

OrdersV2

Orders controller , Contains all the APIs relating to posting,getting,editing and deleting orders

API	Description
GET v2/Orders?page={page}&pageSize={pageSize}	Returns list of orders belongs to the branch
GET v2/Orders/GetOrderListSummary	Returns a summary of all the orders
GET v2/Orders/{id}	Returns a single order
POST v2/Orders	Place a new order
PUT v2/Orders/{id}	Edit an order
DELETE v2/Orders/{id}	Delete an order
GET v2/Orders/{id}/InvoiceItems/{invoiceItemId}	Returns all the invoice items for a single order
GET v2/Orders/{id}/Stills	Returns the url list and url count for all the stills under a specific order
GET v2/Orders/{id}/Floorplans	Returns the a url list and url count for all the floorplans under a specific order
GET v2/Orders/{id}/VirtualTours	Returns virtual tour urls and url count for the order
GET v2/Orders/{id}/Video	Returns video urls and url count for the order
GET v2/Orders/{id}/EPC	Returns EPC report reference number
GET v2/Orders/{id}/Verifications	Returns verification images bundled in a zip file.
GET v2/Orders/{id}/InvoiceItems	Returns all the invoice items for an order
POST v2/Orders/{id}/InvoiceItems	Add extra invoice items to an existing order
PUT v2/Orders/{id}/InvoiceItems/{invoiceItemId}	Edit the quantity of an existing invoice items for a order
DELETE v2/Orders/{id}/InvoiceItems/{invoiceItemId}	Deletes an invoice item from an existing order
GET v2/Orders/{id}/GetAvailablePhotographerBookings	Returns a list of available photographer booking times.
GET v2/Orders/GetAvailablePhotographerBookings?postCode={postCode}&bedrooms={bedrooms}&stills={stills}&elevatedStills={elevatedStills}&virtualTours={virtualTours}&epc={epc}&verification={verification}&video={video}&floorplan={floorplan}	Returns a list of available photographer booking times.
GET v2/Orders/{id}/GetAvailablePhotographerBookingsWithBio	Returns a list of available photographer booking times with their bio details.
POST v2/Orders/{id}/BookPhotographer	Book a photographer
POST v2/Orders/{id}/UnbookPhotographer	Unbook a photographer
POST v2/Orders/{id}/AddBrochure	Adds a brochure to an order.
DELETE v2/Orders/{id}/DeleteBrochure	Deletes a brochure.
GET v2/Orders/{id}/GetAvaiableBrochureTemplates	Returns the list of brochure templates available for the order.
POST v2/Orders/{id}/LinkOrders	Link orders to an existing order
POST v2/Orders/{id}/UnLinkOrders	Unlink orders from an existing order.
POST v2/Orders/{id}/SendConfirmationSms
POST v2/Orders/{id}/SendBrochureUrlEmail	No documentation available.

BrochureTemplatesV2

API	Description
GET v2/BrochureTemplates	No documentation available.

WebhooksV2

API	Description
GET api/WebhooksV2?notificationCode={notificationCode}	Get a single webhook defined under a particular branch.
POST api/WebhooksV2	Setup a webhook to recieve notifications when assets are ready.
DELETE api/WebhooksV2?notificationCode={notificationCode}	Deletes a webhook.