GET api/users/{userId}/properties?PropertyStatus={PropertyStatus}

Get properties linked to a user

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
userId		integer	Required
PropertyStatus	(Optional) The records returned bases on isactive	string	Active

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfProperty

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of Property	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "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
    },
    {
      "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)