Operation
Information of the operation
| Style |
|---|
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
} |
| Div | ||
|---|---|---|
| ||
GET |
| Div | ||
|---|---|---|
| ||
http://{urlName}/tesiproPMS/api/{version}/chain/{chainId}/property/{propertyId}/lostItem |
Request
Response
| Property | Type | Required | Default value | Description | name | String | true | Description of the field. |
|---|
Example request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://81.184.0.161:9696/tesiproPMS/api/v1/chain/1/property/2/lostItem |
| Property | Type | Required | Description | chainId | Integer | true | The id of the chain. This parameter will be in the URL | |
|---|---|---|---|---|---|---|---|---|
| propertyId | Integer | true | The id of the property. This parameter will be in the URL | |||||
| date | Date | false | Filter by date | |||||
| search | String | false | A String that will filter results searching by name, location, and assignedUser | |||||
| roomId | Integer | false | Filter by room | |||||
| profileId | Integer | false | Filter by profile | |||||
| lostItemStatusTypeId | Integer | false | Filter by lostItemStatusType | |||||
| offset | Integer | false | 0 | The offset of the list of results | ||||
| limit | Integer | false | 10 | The limit amount of the list of results | ||||
| sort | String | false | id | field of lostItem to sort by. | ||||
| sortMode | String | false | Asc | Mode of sorting: asc, desc.. |
Example request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://81.184.0.161:9696/tesiproPMS/api/v1/chain/1/property/2/lostItem |
Response
This endpoint returns a paginated Array of entities of type LostItem.
Entity
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example response
| Code Block | ||
|---|---|---|
| ||
{
"count": 3,
"offset": 0,
"limit": 10,
"list": [{
"id": 1,
"createdDate": "2018-08-03T13:51:53.547Z",
"modifiedDate": "2018-08-03T13:51:53.547Z",
"createdUser": 0,
"modifiedUser": 0,
"date": "2018-01-01",
"name": "Item 1",
"foundBy": "Pedro",
"location": "Hall",
"guest": "Carl Anaïs",
"remark": "Remark item",
"lostItemStatusType": {
"id": 2,
"code": "2",
"name": "Lost",
"nameI18n": "Lost",
"colorCode": "#f57c00"
},
"lostItemImageSet": null,
"mainImage": "a5712954-b697-435b-b674-774d69dfdc28.jpg"
},
{
"id": 2,
"createdDate": "2018-08-03T13:51:55.107Z",
"modifiedDate": "2018-08-03T13:51:55.110Z",
"createdUser": 0,
"modifiedUser": 0,
"date": "2018-01-01",
"name": "Item 1",
"foundBy": "Pedro",
"location": "Hall",
"guest": "Craig Yóu",
"remark": "Remark item",
"lostItemStatusType": {
"id": 1,
"code": "1",
"name": "Found",
"nameI18n": "Found",
"colorCode": "#64b5f6"
},
"lostItemImageSet": null
},
{
"id": 3,
"createdDate": "2018-08-03T13:51:55.127Z",
"modifiedDate": "2018-08-03T13:51:55.120Z",
"createdUser": 0,
"modifiedUser": 0,
"date": "2018-01-01",
"name": "Item 1",
"foundBy": "Pedro",
"location": "Hall",
"guest": "Eugene Géraldine",
"remark": "Remark item",
"deliveredTo": "Irene Cléa",
"dateOfDelivery": "2018-01-01",
"documentNumber": "3557842975624616",
"remarkOfDelivery": "Delivery Remark",
"lostItemStatusType": {
"id": 3,
"code": "3",
"name": "Delivered",
"nameI18n": "Delivered",
"colorCode": "#388e3c"
},
"lostItemImageSet": null,
"mainImage": "865a0bc8-be20-4c8a-a98b-0ac2f911da2b.jpg"
}
]
} |