Manufacturers
Get the list of Manufacturers
Path
GET /odata/Manufacturers
Description
Returns the paged list of Manufacturers. Contains the link to the next page and information about overall entities count in the database. Supports Query options.
Request parameters
Parameter |
Explanation |
|---|---|
| api-version: string default: 1.0 in header |
The requested API version. |
| $search: string in query |
Picks the value in all possible fields. |
| $filter: string in query |
Filters the results, based on a Boolean condition. |
| $orderby: string in query |
Sorts the results. |
| $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 |
|---|---|
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationNo: string | Identification Number of the Organization |
| organizationName: string | Name of the Organization |
| manufacturerId: string (uuid) | Unique Identifier of the Manufacturer |
| manufacturerNo: string | Number of the Manufacturer |
| manufacturerName: string | Name of the Manufacturer |
| activeStatus: boolean | Is the status of the Manufacturer active or not? |
| dateCreated: string (date-time) | Date when the Manufacturer was added |
| createdBy: string (uuid) | Unique Identifier of the user who added Manufacturer |
| createdByName: string | Name of the user who added Manufacturer |
| lastUpdated: string (date-time) | Last Date when the Manufacturer was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Manufacturer |
| lastUpdatedByName: string | Name of the last user who updated the Manufacturer |
| externalMfgNo: string | External Manufacturer Number |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
Response Example (200 OK)
{
"items": [
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationNo": "string",
"organizationName": "string",
"manufacturerId": "00000000-0000-0000-0000-000000000000",
"manufacturerNo": "string",
"manufacturerName": "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",
"externalMfgNo": "string"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Create a new Manufacturer
Path
POST /odata/Manufacturers
Description
Creates a new Manufacturer within a logged organization.
Request body
If Auto ID is configured for a manufacturer, then manufacturerNo is optional.
Parameter |
Explanation |
|---|---|
| manufacturerNo: string | Number of the Manufacturer |
| manufacturerName: string required |
Name of the Manufacturer |
If Auto ID is not configured for a manufacturer, then manufacturerNo and manufacturerName are required.
Parameter |
Explanation |
|---|---|
| manufacturerNo: string required |
Number of the Manufacturer |
| manufacturerName: string required |
Name of the Manufacturer |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example
Request Example
{
"manufacturerNo": "string",
"manufacturerName": "string",
}
Note
The request with externalMfgNo could be sent only by System users.
Parameter |
Explanation |
|---|---|
| manufacturerNo: string required |
Number of the Manufacturer |
| manufacturerName: string required |
Name of the Manufacturer |
| externalMfgNo: string | External Manufacturer Number |
Request parameters
Parameter |
Explanation |
|---|---|
| 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. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
Response Example (200 OK)
"00000000-0000-0000-0000-000000000000"
Get the specified Manufacturer
Path
GET /odata/Manufacturers({manufacturerId})
Description
Returns the details of the Manufacturer specified by ID.
Request parameters
Parameter |
Explanation |
|---|---|
| manufacturerId: string (uuid) required in path |
Enter the ID of the Manufacturer 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 |
|---|---|
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationNo: string | Identification Number of the Organization |
| organizationName: string | Name of the Organization |
| manufacturerId: string (uuid) | Unique Identifier of the Manufacturer |
| manufacturerNo: string | Number of the Manufacturer |
| manufacturerName: string | Name of the Manufacturer |
| activeStatus: boolean | Is the status of the Manufacturer active or not? |
| dateCreated: string (date-time) | Date when the Manufacturer was added |
| createdBy: string (uuid) | Unique Identifier of the user who added Manufacturer |
| createdByName: string | Name of the user who added Manufacturer |
| lastUpdated: string (date-time) | Last Date when the Manufacturer was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Manufacturer |
| lastUpdatedByName: string | Name of the last user who updated the Manufacturer |
| externalMfgNo: string | External Manufacturer Number |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
Response Example (200 OK)
{
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationNo": "string",
"organizationName": "string",
"manufacturerId": "00000000-0000-0000-0000-000000000000",
"manufacturerNo": "string",
"manufacturerName": "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",
"externalMfgNo": "string"
}