GET api/properties/{id}

Get property from a specific market with a property ID

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Property
NameDescriptionTypeAdditional information
PropertyId

Property Id. Primary key of the properties table.

 integer

None.
C4Uid

Market id.

 string

None.
PropertyName

Property Name.

 string

None.
Address1

Address 1.

 string

None.
Address2

Address 2.

 string

None.
City

City.

 string

None.
State

See api/collections/{CollectionId}/collectionitems route to get all states values.

 string

None.
Zip

Zip code.

 string

None.
EntityNumber

Entity Number

 string

None.
AccountingServerId

Accounting Software Id. See api/accountingservers

 integer

None.
LegalName

Property Legal Name

 string

None.
PropertyTypeId

Property Type Id 1 Condo/Highrise 2 HOA

 integer

None.
SecondaryPropertyTypeId

Secondary Property Type Id

 integer

None.
AccountingSoftwareId

Accounting Software Id 1 FAMASS Jenark 2 BJMURRAY BJMurray 3 CAMACCT CamAcct 4 ReManage ReManage 5 Yardi Yardi

 integer

None.
PropertyStatus

True False

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "PropertyId": 1,
  "C4Uid": "sample string 2",
  "PropertyName": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "Zip": "sample string 8",
  "EntityNumber": "sample string 9",
  "AccountingServerId": 1,
  "LegalName": "sample string 10",
  "PropertyTypeId": 1,
  "SecondaryPropertyTypeId": 1,
  "AccountingSoftwareId": 1,
  "PropertyStatus": true
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)