Classifications
Get the list of Classifications
Path
GET /odata/Classifications
Description
Returns the list of Classifications 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. |
| 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 |
|---|---|
| classificationId: string (uuid) | Unique Identifier of the Сlassification |
| classificationName: string | Name of the Сlassification |
| classificationTypeId: integer (int32) | Unique Identifier of the Classification Type |
| classificationTypeValue: string | Type Value of the Classification |
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationNo: string | Identification Number of the Organization |
| organizationName: string | Name of the Organization |
| activeStatus: boolean | Is the Classification active or not? |
| dateCreated: string (date-time) |
Date when the Classification was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the Classification |
| createdByName: string | Name of the user who created the Classification |
| lastUpdated: string (date-time) | Last Date when the Classification was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Classification |
| lastUpdatedByName: string | Name of the last user who updated the Classification |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"classificationId": "00000000-0000-0000-0000-000000000000",
"classificationName": "string",
"classificationTypeId": "integer (int32)",
"classificationTypeValue": "string",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationNo": "string",
"organizationName": "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)"
}
Create a new Classification
Path
POST /odata/Classifications
Description
Creates a new Classification within a logged organization.
Request body
Parameter |
Explanation |
|---|---|
| classificationName: string required |
Name of the Сlassification |
| classificationTypeId: integer (int32) required |
Unique Identifier of the Classification Type |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example
Request Example
{
"classificationName": "string",
"classificationTypeId": "integer (int32)",
}
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 Classification
Path
GET /odata/Classifications({ClassificationId})
Description
Returns the details of the Classification specified by ID within a logged organization.
Request parameters
Parameter |
Explanation |
|---|---|
| classificationId: string (uuid) required in path |
Enter the ID of the Classification 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 |
|---|---|
| classificationId: string (uuid) | Unique Identifier of the Сlassification |
| classificationName: string | Name of the Сlassification |
| classificationTypeId: integer (int32) | Unique Identifier of the Classification Type |
| classificationTypeValue: string | Type Value of the Classification |
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationNo: string | Identification Number of the Organization |
| organizationName: string | Name of the Organization |
| activeStatus: boolean | Is the Classification active or not? |
| dateCreated: string (date-time) |
Date when the Classification was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the Classification |
| createdByName: string | Name of the user who created the Classification |
| lastUpdated: string (date-time) | Last Date when the Classification was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Classification |
| lastUpdatedByName: string | Name of the last user who updated the Classification |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"classificationId": "00000000-0000-0000-0000-000000000000",
"classificationName": "string",
"classificationTypeId": "integer (int32)",
"classificationTypeValue": "string",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationNo": "string",
"organizationName": "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"
}