You get a list of companies or suppliers that match your search criteria.
Petition Details
- Base URL: {host}/ASMSAPI/
- Uri: /api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}
- Type: GET
-
Required headings:
- content-type: application/json
- X-Authorization: Bearer {token}
URL Description
- {host}: It represents the domain of the environment in which the API is located.
- ASMSAPI/: Fixed API prefix.
- URI: Specific endpoint for the request.
⚐ EJEMPLO URL:
https://{host}/ASMSAPI/api/api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}
Parameters
Name | Data type | Obligatory | Description |
---|---|---|---|
itemType | Enumerator | Yes | Search type (Compañia = 38 , Proveedor = 52 ) |
projectId | Number | No | Project ID |
clientId | Number | No | Customer ID |
serviceId | Number | No | Service Identifier |
Criteria | Text | No | User Search Text |
filterCaseUser | Text | No | Determine if you should pre-filter per customer |
Body of the petition
N/A
Examples of uri
api/v9/company/search?itemType=38&projectId=2&criteria=Guia
api/v9/company/search?itemType=52&projectId=2
api/v9/company/search?itemType=38&projectId=2&criteria=
Answer
{
"content": [
{
"id": 1,
"locationId": 2,
"name": "Guia"
}
],
"totalItems": 1
}
Response Parameters
Title | Data type | Description |
---|---|---|
Id | Number | Company ID |
Location | Text | Company Location |
Name | Text | Company Name |
Error Messages
Code | HTTP status | Error Message |
---|---|---|
403 | Forbidden | AccessDenied |
500 | InternalServerError | FailureGetDetail |