5.3 Search Interested Parties

Updated at: 3/27/2023 12:33:46 AM

Url

/api/v2/{fleet_token}/contractors/{contractor_id}/interestedparties/search

Method

Post

Body

```json { "Name": { "Op": "EQ|CS", "Val": "<contractor_name>" }, "PageSize": "<page_size>", "PageNumber": "<page_number>" } ```

Parameters

- `Name` Optional. - `Op`Optional. Default to `EQ`. Available operators: - `EQ`: equals to - `CS`: contains string - `Val` Required if `Name` element is present - `PageSize` Optional. Default to 20. Will return full list if set to 0 or a negative value. - `PageNumber` Optional. Default to 1. will return the first page if set to 0 or a negative value.

Response

```json { "Success": true, "Message": "", "Data": { "PageSize": 20, "PageNumber": 1, "TotalCount": 1, "TotalPages": 1, "Items": [ { "ID": <interested_party_id>, "Name": "<interested_party_name>", "Email": "<interested_party_email>", "PhoneNumber": "<interested_party_phone_number", "Address": "<interested_party_address>", "Address2": "<interested_party_address2>", "City": "<interested_party_city>", "State": "<interested_party_state>", "Zip": "<interested_party_zip>", "Type": "<interested_party_type>" } ] } } ```

Returns

- `TotalPages` total number of pages. - `TotalCount` total number of units. - `PageNumber` current page. - `PageSize` number of units per page. - `Items` the units on current page.

Notes

- Interested Parties can be searched by name.
In this article