EN
Español
English
Português
    User Search

    Petition Details

    • URL Base: {host}/ASMSAPI/
    • URI: /api/v9/user/searchAll?projectId={projectId}&serviceId={serviceId}&companyId={companyId}&itemType={itemType}&criteria={criteria}
    • Guy: 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/v9/user/searchAll?projectId={projectId}&serviceId={serviceId}&companyId={companyId}&itemType={itemType}&criteria={criteria}
    


    Parameters

    Name Data type Obligatory Description
    itemType Enumerator Yes Search Type:
    • Client = 37
    • Specialist = 53
    projectId Number No Project ID
    serviceId Number No Service Identifier
    companyId Number No Company Identifier
    Criteria Text No User Search Text

    Body of the petition

    N/A

    Examples of URIs

    • /api/v9/user/searchAll?itemType=specialist&projectId=2&criteria=abdy
    • /api/v9/user/searchAll?itemType=specialist&projectId=2&criteria=
    • /api/v9/user/searchAll?itemType=specialist&projectId=2

    Answer

    {
        "content": [
            {
                "email": "tri@pri.comx",
                "id": 150,
                "name": "Abdy Sanjur",
                "userName": "ASANJUR"
            }
        ],
        "totalItems": 1
    }
    

    Response parameters

    Name Data type Description
    totalItems Number Total number of objects found
    content List Item listing
    email Text User Email
    Id Number User ID
    Name Text Username
    userName Text User aliases

    Error messages

    Code HTTP status Error Message
    500 InternalServerError FailureSearchUsers
    400 BadRequest InvalidTypeForSearch