Prop Data API

Examples

All examples below use CURL.

The following examples use the branch model. However, each of the requests and responses will be uniform throughout all the models defined in this document. Click here for information regarding the schema

Summary

Request

curl --request GET \
  --url $FEEDS_URL/eos/v1/{endpoint-resource}/summary/ \
  --header 'api_key: some-api-key' \
  --header 'content-type: application/json' \
  --header 'upstream_host: sandbox.propdata.net

Response

  {
  "status": 200,
  "request_time": "2017-05-26T08:07:59.509235",
  "upstream_host": "sandbox.propdata.net",
  "detail": null,
  "filters": {},
  "request_id": "K049PHBFVG43K3PXX2KGT3AAGMMT",
  "response": [
    {
      "last_modified": "2017-02-16T11:41:24.389",
      "id": 5
    },
    {
      "last_modified": "2017-04-26T13:14:03.235",
      "id": 1
    }
  ]
}

Detail

Request

curl --request GET \
  --url $FEEDS_URL/eos/v1/{endpoint-resource}/detail/2/ \
  --header 'api_key: some-api-key' \
  --header 'upstream_host: sandbox.propdata.net'

Response

{
  "status": 200,
  "request_time": "2017-05-24T14:57:22.318709",
  "request_id": "K070KJBJK0KHF2PET4KV5JF1HQNC",
  "response": {
    "status": "Active",
    "privy_seal_image_url": "",
    "telephone_number": "2660035",
    "map_y_position": "",
    "email_address": "jonathan@propdata.net",
    "google_plus_url": "",
    "privy_seal_url": "",
    "id": 2,
    "map_x_position": "",
    "branch_franchisees": [],
    "telephone_code": "031",
    "province": "Gauteng",
    "physical_address": "12 Sookhai Place\nDerby Downs Office Park\nWestville\n3610",
    "fax_code": "",
    "postal_address": "12 Sookhai Place\nDerby Downs Office Park\nWestville\n3610",
    "twitter_url": "",
    "facebook_url": "",
    "fax_number": "",
    "branch_name": "Jonathan Test2 yay!",
    "head_office": false,
    "last_modified": "2017-05-24T12:36:25.555001",
    "agent_of_the_month": null,
    "date_added": "2017-01-26T09:36:00.264179",
    "youtube_url": "",
    "branch_profile": "",
    "pinterest_url": "",
    "branch_managers": [],
    "linkedin_url": "",
    "branch_website": null,
    "blog_url": "",
    "display": true
  },
  "upstream_host": "sandbox.propdata.net"
}

Create

Request


curl --request POST \
  --url $FEEDS_URL/eos/v1/{endpoint-resource}/create/ \
  --header 'api_key: some-api-key' \
  --header 'content-type: application/json' \
  --header 'upstream_host: sandbox.propdata.net' \
  --data '{
    "status": "Active",
    "branch_name": "PD api test 2",
    "telephone_code": "031",
    "telephone_number": "2660035",
    "province": "Gauteng",
    "physical_address": "12 Sookhai Place
      Derby Downs Office Park
      Westville
      3610",
    "email_address": "jonathan@propdata.net",
    "postal_address": "12 Sookhai Place
Derby Downs Office Park
Westville
3610"
}'

Response

{
  "status": 201,
  "request_time": "2017-05-26T08:08:45.252301",
  "request_id": "K04ZMTTBAF3NG38TSSG7GFD153D2",
  "response": {
    "id": 15,
    "date_added": "2017-02-16T11:41:24.389"
  },
  "upstream_host": "sandbox.propdata.net"
}

Update

Request

curl --request POST \
  --url $FEEDS_URL/eos/v1/{endpoint-resource}/update/13/ \
  --header 'api_key: some-api-key' \
  --header 'content-type: application/json' \
  --header 'upstream_host: sandbox.propdata.net' \
  --data '{
    "status": "Active",
    "branch_name": "PD api test",
    "telephone_code": "031",
    "telephone_number": "2660035",
    "province": "Gauteng",
    "physical_address": "12 Sookhai Place
      Derby Downs Office Park
      Westville
      3610",
    "email_address": "jonathan@propdata.net",
    "postal_address": "12 Sookhai Place
      Derby Downs Office Park
      Westville
      3610"
}'

Response

{
  "status": 201,
  "request_time": "2017-05-26T07:58:03.260844",
  "request_id": "K05MVJXWJS11TZKRRQN42JKH42C9",
  "response": {
    "last_modified": "2017-05-26T07:58:04.705617",
    "id": 13
  },
  "upstream_host": "sandbox.propdata.net"
}