- 22 Oct 2024
- 10 Minutes to read
- Print
- DarkLight
/Endpoint/rest/api/v1/Location
- Updated on 22 Oct 2024
- 10 Minutes to read
- Print
- DarkLight
Use the LocationData
object resource to insert or update (Upsert) Location
using Id, Name, ExternalId
field(s) value.
You can supply the required field values in the request data, and then use the POST
method of the resource.
The input parameter must be used in the LocationData
record structure inside the FieldType
parameter in the foreign key fields.
Foreign key fields are: CountryId, TimezoneId, CurrencyId, ModifiedBy, CreatedBy
Update a record of Location
- If the
Id
field value is not matched, then a404
error is reported (Errors/Not Found
), and the error record is returned.. You cannot changeId
field value (primary key). - If the
Name,ExternalId
field value is not empty andId
field value is empty, action try insert record accordingName,ExternalId
field value (if set, the value is a unique identifier).
Create a new record of Location
- If the value in the
Name,ExternalId
andId
fields are empty then action insert a new record according input parameter entity record structure (LocationData
).
The response body will contain the object of the updated or created record if the call is successful. Method returns an extended Location
structure. Here, all foreign key fields are abstract object structures, utilizing AbstractText
or AbstractLong
data types, offering a detailed view of the data and related entities.
oAuth autentication flow
Location
information to insert or update.
The input parameter must be used in the LocationData
record structure inside the FieldType
parameter in the foreign key fields.
The record of Location information.
The guid to identify the location.
The external identifier of the location.
The name of the location.
The enum of Country.
The enum of Timezone.
The enum of Currency.
Defines if the location is active and can be used.
Inserted or updated Location
information.
The record of Location information.
The guid to identify the location
The external identifier of the location
The name of the location
This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
Defines if the location is active and can be used
The date the record was updated
This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
The date the record was created
Bad Request - The user has provided input that the browser is unable to convert.
{
"Errors": [
"The user has provided input that the browser is unable to convert.",
"There are multiple rows in the database for the same value",
"The value does not match the specified entity structure",
"..."
],
"Type": "/Errors/Bad Input",
"Title": "Bad Request",
"StatusCode": 400,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.
Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.
{
"Errors": [
"The session Id or OAuth token used has expired or is invalid."
],
"Type": "/Errors/Unauthorized",
"Title": "Unauthorized",
"StatusCode": 401,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.
Forbidden - The user does not have access to execute operation
{
"Errors": [
"The user does not have access to execute operation"
],
"Type": "/Errors/Permission",
"Title": "Bad Request",
"StatusCode": 403,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.
Internal Server Error - An internal server error is an error on the web server you're trying to access.
{
"Errors": [
"An internal server error is an error on the web server you're trying to access."
],
"Type": "/Errors/Internal Server Error",
"Title": "Internal Server Error",
"StatusCode": 500,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.