Class LocationsApi

Hierarchy

LocationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LocationsApi(basePath?: string): LocationsApi

- Defined in api/api.ts:53541
Parameters
- Optional basePath: string
Returns LocationsApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

systemLocationsCountGet

systemLocationsCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:53554
Get Location Count

Parameters
- params: object
  - Optional conditions?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

systemLocationsGet

systemLocationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Location>>

- Defined in api/api.ts:53595
Get Location

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<Location>>

systemLocationsIdDelete

systemLocationsIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:53651
Delete Location By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

systemLocationsIdGet

systemLocationsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Location>

- Defined in api/api.ts:53688
Get Location By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Location>

systemLocationsIdPatch

systemLocationsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Location>

- Defined in api/api.ts:53726
Update Location

Parameters
- params: object
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Location>

systemLocationsIdPut

systemLocationsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Location>

- Defined in api/api.ts:53771
Replace Location

Parameters
- params: object
  - id: number
  - location: Location
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Location>

systemLocationsPost

systemLocationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Location>

- Defined in api/api.ts:53815
Create Location

Parameters
- params: object
  - location: Location
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Location>

Generated using TypeDoc