Appearance

Create Locations ​

Endpoint ​

http
POST /unified/hris/locations
Integrations supported
  • ServiceNow

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for locations

Supported in
  • ServiceNow
name
string

This represents the name of the location

Supported in
  • ServiceNow
phone_number
object

This represents the phone number of the location

Supported in
  • ServiceNow
number
string

This represents the phone number of the location

extension
string

This represents the extension of the phone number of the location

street_1
string

This represents the Line 1 of the location's street address.

Supported in
  • ServiceNow
street_2
string

This represents the Line 2 of the location's street address.

city
string

This represents the city

Supported in
  • ServiceNow
state
string

This represents the state

Supported in
  • ServiceNow
postal_code
string

This represents the zip

Supported in
  • ServiceNow
country
string

This represents the country

Supported in
  • ServiceNow
location_type
string

This represents the location type

created_at
string · date-time

This represents the date when the locations was created

Supported in
  • ServiceNow
updated_at
string · date-time

This represents the date when the locations was updated

Supported in
  • ServiceNow
remote_data
object

Raw data returned from the remote API call.