PARAreas
Get the list of PAR Areas
Path
GET /odata/PARAreas
Description
Returns the list of PAR Areas within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).
Request parameters
Parameter |
Explanation |
|---|---|
| api-version: string default: 1.0 in header |
The requested API version. |
| $filter: string in query |
Restricts the set of items returned. The maximum number of expressions is 100. |
| $orderby: string in query |
Specifies the order in which items are returned. The maximum number of expressions is 5. |
| $search: string in query |
Picks the value in all possible fields. |
| $top: string in query |
Returns only the first n results. |
| $skip: string in query |
Skips the first n results. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 400 Bad Request | The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| parAreaId: string (uuid) | Unique Identifier of the PAR Area |
| parAreaNo: string | Identification Number of the PAR Area |
| parAreaName: string | Name of the PAR Area |
| facilityId: string (uuid) | Unique Identifier of the Facility |
| facilityNo: string | Identification Number of the Facility |
| facilityName: string | Name of the Facility |
| departmentId: string (uuid) | Unique Identifier of the Department |
| departmentNo: string | Number of the Department |
| departmentName: string | Name of the Department |
| glCode: string | General Ledger Code |
| reference: string | Information concerning the Transaction |
| activeStatus: boolean | Is PAR Area active or not? |
| dateCreated: string (date-time) | Date when the PAR Area was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the PAR Area |
| createdByName: string | Name of the user who created the PAR Area |
| lastUpdated: string (date-time) | Last Date when the PAR Area was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the PAR Area |
| lastUpdatedByName: string | Name of the last user who updated the PAR Area |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"parAreaId": "00000000-0000-0000-0000-000000000000",
"parAreaNo": "string",
"parAreaName": "string",
"facilityId": "00000000-0000-0000-0000-000000000000",
"facilityNo": "string",
"facilityName": "string",
"departmentId": "00000000-0000-0000-0000-000000000000",
"departmentNo": "string",
"departmentName": "string",
"glCode": "string",
"reference": "string",
"activeStatus": "boolean",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Get the specified PAR Area
Path
GET /odata/PARAreas({parAreaId})
Description
Returns the details of the PAR Area specified by ID within a logged organization.
Request parameters
Parameter |
Explanation |
|---|---|
| parAreaId: string (uuid) required in path |
Enter the ID of the PAR Area here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 404 Not Found | Specified ID is absent in the system. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| parAreaId: string (uuid) | Unique Identifier of the PAR Area |
| parAreaNo: string | Identification Number of the PAR Area |
| parAreaName: string | Name of the PAR Area |
| facilityId: string (uuid) | Unique Identifier of the Facility |
| facilityNo: string | Identification Number of the Facility |
| facilityName: string | Name of the Facility |
| departmentId: string (uuid) | Unique Identifier of the Department |
| departmentNo: string | Number of the Department |
| departmentName: string | Name of the Department |
| glCode: string | General Ledger Code |
| reference: string | Information concerning the Transaction |
| activeStatus: boolean | Is PAR Area active or not? |
| dateCreated: string (date-time) | Date when the PAR Area was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the PAR Area |
| createdByName: string | Name of the user who created the PAR Area |
| lastUpdated: string (date-time) | Last Date when the PAR Area was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the PAR Area |
| lastUpdatedByName: string | Name of the last user who updated the PAR Area |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"parAreaId": "00000000-0000-0000-0000-000000000000",
"parAreaNo": "string",
"parAreaName": "string",
"facilityId": "00000000-0000-0000-0000-000000000000",
"facilityNo": "string",
"facilityName": "string",
"departmentId": "00000000-0000-0000-0000-000000000000",
"departmentNo": "string",
"departmentName": "string",
"glCode": "string",
"reference": "string",
"activeStatus": "boolean",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string"
}
Get the list of PAR Area Items for the specified PAR Area
Path
GET /odata/PARAreas({parAreaId})/parAreaLineItems
Description
Returns the list of the existing PAR Area Items within PAR Area specified by ID. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).
Request parameters
Parameter |
Explanation |
|---|---|
| parAreaId: string (uuid) required in path |
Enter the ID of the Par Area here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| $filter: string in query |
Restricts the set of items returned. The maximum number of expressions is 100. |
| $orderby: string in query |
Specifies the order in which items are returned. The maximum number of expressions is 5. |
| $search: string in query |
Picks the value in all possible fields. |
| $top: string in query |
Returns only the first n results. |
| $skip: string in query |
Skips the first n results. |
| Authorization: string default: Bearer access_token in header |
Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication. |
Responses
Response |
Explanation |
|---|---|
| 200 OK | OK |
| 400 Bad Request | Incorrect input data or organization ID does not match with the organization ID user is logged in. |
| 400 Bad Request | The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| parAreaItemId: string (uuid) | Unique Identifier of the PAR Area Item |
| parAreaId: string (uuid) | Unique Identifier of the PAR Area |
| parAreaNo: string | Identification Number of the PAR Area |
| parAreaName: string | Name of the PAR Area |
| inventoryLocationId: string (uuid) | Unique Identifier of the Inventory Location |
| locationNo: string | Identification Number of the Location |
| locationName: string | Name of the Location |
| lineItemNo: integer (int32) | Number of the Line Item |
| inventoryNo: string | Identification code of the Inventory Item |
| inventoryDescription: string | Description of the Inventory Item |
| notes: string | Comments about the PAR Area Item |
| minQuantity: integer (int32) | Minimal Items Quantity for this PAR Area |
| maxQuantity: integer (int32) | Maximal Items Quantity for this PAR Area |
| uom: string | Unit of Measure |
| conversionFactor: integer (int32) |
Number of Stock Keeping Units in another Unit of Measure |
| binShelf: string | Level of the storage within PAR Area |
| lastCountDate: string (date-time) | Date when the last PAR Count was created for this PAR Area Item |
| gtin: string | Global Trade Item Number |
| manufacturerItemNo: string | Item Number of the Manufacturer |
| activeStatus: boolean | Is the status of the PAR Area Item active or not? |
| dateCreated: string (date-time) | Date when PAR Area Item the was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the PAR Area Item |
| createdByName: string | First Name and Last Name of the user who added PAR Area Item |
| lastUpdated: string (date-time) | Last Date when the PAR Area Item was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the PAR Area Item |
| lastUpdatedByName: string | First Name and Last Name of the last user who updated the PAR Area Item |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"parAreaId": "00000000-0000-0000-0000-000000000000",
"parAreaNo": "string",
"parAreaName": "string",
"inventoryLocationId": "00000000-0000-0000-0000-000000000000",
"locationNo": "string",
"locationName": "string",
"lineItemNo": "integer (int32)",
"inventoryNo": "string",
"inventoryDescription": "string",
"notes": "string",
"minQuantity": "integer (int32)",
"maxQuantity": "integer (int32)",
"uom": "string",
"conversionFactor": "integer (int32)",
"binShelf": "string",
"lastCountDate": "string (date-time)",
"gtin": "string",
"manufacturerItemNo": "string",
"activeStatus": "boolean",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}