Batch Update Offices
put
/api/restapi/office/batch
Send a request to this endpoint to update one or more offices.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityOffice>
Type:
array
Title:
Show Source
List<ApiEntityOffice>
-
Array of:
object ApiEntityOffice
Title:
ApiEntityOffice
Nested Schema : ApiEntityOffice
Type:
object
Title:
Show Source
ApiEntityOffice
-
addressLine1: string
Maximum Length:
200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Maximum Length:
200
The second line of the address of a location.
This might be a neighborhood or town. -
cityName: string
Maximum Length:
200
The name of the city for a location. -
companyId: integer
(int64)
The unique identifier for the company.The company object can also be identified by its unique criteria.
-
companyName: string
Minimum Length:
1
Maximum Length:255
The name of the company. -
countryCode: string
Minimum Length:
0
Maximum Length:3
The country for a location. -
distance: number
(double)
The distance the company is willing to travel for the project from this office.
-
distanceMetric: string
Allowed Values:
[ "KILOMETERS", "MILES" ]
The distance measure to be used. Valid options include kilometer and mile. -
fax: string
Maximum Length:
32
The fax number for the office. -
isCorporateOffice: boolean
Indicates if the office is the headquarters of the company.
-
latitude: number
(double)
Minimum Value:
-90
Maximum Value:90
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
longitude: number
(double)
Minimum Value:
-180
Maximum Value:180
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service. -
officeCountryCode: string
Minimum Length:
0
Maximum Length:200
The country for a location. -
officeId: integer
(int64)
The unique identifier of an office.
-
officeName: string
Minimum Length:
1
Maximum Length:255
The name of the office. -
officePostalCode: string
Minimum Length:
0
Maximum Length:200
The postal code, post code, or zip code of a location. -
orgOfficeId: integer
(int64)
The unique identifier of the organization of the office.
-
phone: string
Maximum Length:
32
The phone number for the office. -
postalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
stateName: string
Maximum Length:
200
The state, region, or province of a location. -
updateDate: string
(date-time)
Date when the record was last updated.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
204 Response
Successful operation with no content.
400 Response
Invalid Input.