GET api/packages/{id}
Get Package by Id
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PackageTracking| Name | Description | Type | Additional information |
|---|---|---|---|
| PackageId |
PackageId |
integer |
None. |
| PropertyId |
Property Id |
integer |
None. |
| UnitId |
Unit Id |
integer |
None. |
| ResidentId |
Resident Id |
integer |
None. |
| Sender |
Package Sender |
string |
None. |
| SenderAddress1 |
Sender Address1 |
string |
None. |
| SenderAddress2 |
Sender Address2 |
string |
None. |
| SenderCity |
Sender City |
string |
None. |
| SenderState |
Sender State |
string |
None. |
| SenderZip |
Sender Zip |
string |
None. |
| Details |
Details |
string |
None. |
| Status |
Status |
string |
None. |
| Type |
Type |
string |
None. |
| PackageCreated |
Package Created Date |
date |
None. |
| PickedUpBy |
PickedUp By Name |
string |
None. |
| PickedUpOn |
Pickup Date |
string |
None. |
| TrackingNumber |
Tracking Number |
string |
None. |
| Shipper |
Shipper |
string |
None. |
| CreatedBy |
Created By |
integer |
None. |
| CreatedOn |
Created On |
date |
None. |
| LastModifiedBy |
Last Modified By |
integer |
None. |
| LastModifiedOn |
Last Modified On |
date |
None. |
| ReceivingSigFilePath |
Receiving Signature File Path. To get the file use api/files?filePath={value in this property} |
string |
None. |
| ReceivingSigFileDate |
Receiving Signature File Date |
date |
None. |
| FrontDeskSigFilePath |
FrontDesk Signature File Path. To get the file use api/files?filePath={value in this property} |
string |
None. |
| FrontDeskSigFileDate |
FrontDesk Signature File Date |
date |
None. |
| ValetSigFilePath |
Valet Signature File Path. To get the file use api/files?filePath={value in this property} |
string |
None. |
| ValetSigFileDate |
Valet Signature File Date |
date |
None. |
| ResidentSigFilePath |
Resident Signature File Path. To get the file use api/files?filePath={value in this property} |
string |
None. |
| ResidentSigFileDate |
Resident Signature File Date |
date |
None. |
Response Formats
application/json, text/json
{
"PackageId": 1,
"PropertyId": 2,
"UnitId": 1,
"ResidentId": 1,
"Sender": "sample string 3",
"SenderAddress1": "sample string 4",
"SenderAddress2": "sample string 5",
"SenderCity": "sample string 6",
"SenderState": "sample string 7",
"SenderZip": "sample string 8",
"Details": "sample string 9",
"Status": "sample string 10",
"Type": "sample string 11",
"PackageCreated": "2025-12-24T05:22:14.1738281-05:00",
"PickedUpBy": "sample string 12",
"PickedUpOn": "sample string 13",
"TrackingNumber": "sample string 14",
"Shipper": "sample string 15",
"CreatedBy": 1,
"CreatedOn": "2025-12-24T05:22:14.1738281-05:00",
"LastModifiedBy": 1,
"LastModifiedOn": "2025-12-24T05:22:14.1738281-05:00",
"ReceivingSigFilePath": "sample string 16",
"ReceivingSigFileDate": "2025-12-24T05:22:14.1738281-05:00",
"FrontDeskSigFilePath": "sample string 17",
"FrontDeskSigFileDate": "2025-12-24T05:22:14.1738281-05:00",
"ValetSigFilePath": "sample string 18",
"ValetSigFileDate": "2025-12-24T05:22:14.1738281-05:00",
"ResidentSigFilePath": "sample string 19",
"ResidentSigFileDate": "2025-12-24T05:22:14.1738281-05:00"
}
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)