Jump to

• Request
• Response

Fetch list of users that may or may not be a vendor

get

/api/1.0/usergroup/fetchUsers

This service is used to retrieve list of users that may or may not be a Vendor.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit: integer
  limit
• offset: integer
  Vendor Flag
• userLoginId: string
  User Login Id
• userName: string
  User Name
• vendorFlg: boolean
  Vendor Flag

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns List of User IDs based on Vendor Flag.

Body ()

Root Schema : UserIdCollection

Type: object

Show Source

• data: array data
• paging: object PagingDto

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserIdDto"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object UserIdDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserIdDto"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : UserIdDto

Type: object

Show Source

• userLoginId: string
• userName: string

{
    "type":"object",
    "properties":{
        "userLoginId":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top