1. Create Property
Op name
scgrids.createProperty
This creates a new Property object given an Organisation and increments the Property Metrics counter
Endpoint:
Method: POST
Type: application/json
URL: /v1/actions
Headers:
| Key | Value | Description |
|---|---|---|
| Authorization | (Required) The Acccess Token or HMAC Signature | |
| x-sc-identity | external | (Required) |
Query params:
| Key | Value | Description |
|---|---|---|
| op | scgrids.createProperty | (Required) Operation name |
| org | (Required) Organisation ID | |
| pid | scnoop | (Required) The pid will be scnoop it it’s not known |
Body:
{
"Name": "Test Property",
"TypeID": "TEST",
"Address": {
"Street": "16th Cross, J P Nagar",
"City": "Bangalore",
"State": "Karnataka",
"Country": "India",
"PostalCode": "560078",
"Coordinates": {
"Latitude": 3.165725,
"Longitude": 101.646267
}
},
"TimeZone": "Asia/Kolkata",
"Country": "",
"CountryLocale": ""
}
More example Requests/Responses:
I. Example Request: Create Property
Body:
{
"Name": "Test Property",
"TypeID": "BANK",
"Address": {
"Street": "16th Cross, J P Nagar",
"City": "Bangalore",
"State": "Karnataka",
"Country": "India",
"PostalCode": "560078",
"Coordinates": {
"Latitude": 3.165725,
"Longitude": 101.646267
}
},
"TimeZone": "Asia/Kolkata",
"Country": "",
"CountryLocale": ""
}
I. Example Response: Create Property
{
"status": 201,
"message": "Successfully created a Property!",
"data": {
"OrgId": "",
"PropId": "",
"Name": "Test Property 2",
"Address": {
"Street": "16th Cross, J P Nagar",
"City": "Bangalore",
"State": "Karnataka",
"Country": "India",
"PostalCode": "560078",
"Coordinates": {
"Latitude": 3.165725,
"Longitude": 101.646267
}
},
"TypeID": "BANK",
"Status": "Active"
}
}
Status Code: 200
Error codes: