Jump to

• Request
• Response

Read Locations

get

/location

Reads Location objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<Location>

Type: array

Title: List<Location>

Show Source

• Array of: object Location
  Title: Location

  Location Entity

{
    "title":"List<Location>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Location"
    }
}

Nested Schema : Location

Type: object

Title: Location

Location Entity

Show Source

• AddressLine1: string
  The first line of the address with street number and street name.
• AddressLine2: string
  The second line of the address with street number and street name.
• City: string
  The city name of the address.
• Country: string
  The country of the address.
• CountryCode: string
  The country code of the address.
• CreateDate: string (date-time)
  The creation date of the Location.
• CreateUser: string
  The name of the user that created this location.
• LastUpdateDate: string (date-time)
  The date this location was last updated.
• LastUpdateUser: string
  The name of the user that last updated this location.
• Latitude(required): number (double)
  The latitude of the address.
• Longitude(required): number (double)
  The longitude of the address.
• Municipality: string
  The municipality name of the address.
• Name(required): string
  The name of the location.
• ObjectId: integer (int32)
  The unique ID of the location.
• PostalCode: string
  The postal code of the address.
• State: string
  The state name of the address.
• StateCode: string
  The state abbreviation of the address.

{
    "title":"Location",
    "required":[
        "Latitude",
        "Longitude",
        "Name"
    ],
    "type":"object",
    "properties":{
        "AddressLine1":{
            "type":"string",
            "description":"The first line of the address with street number and street name."
        },
        "AddressLine2":{
            "type":"string",
            "description":"The second line of the address with street number and street name."
        },
        "City":{
            "type":"string",
            "description":"The city name of the address."
        },
        "Country":{
            "type":"string",
            "description":"The country of the address."
        },
        "CountryCode":{
            "type":"string",
            "description":"The country code of the address."
        },
        "CreateDate":{
            "type":"string",
            "description":"The creation date of the Location.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this location."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this location was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this location."
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the address.",
            "format":"double"
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the address.",
            "format":"double"
        },
        "Municipality":{
            "type":"string",
            "description":"The municipality name of the address."
        },
        "Name":{
            "type":"string",
            "description":"The name of the location."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID of the location.",
            "format":"int32"
        },
        "PostalCode":{
            "type":"string",
            "description":"The postal code of the address."
        },
        "State":{
            "type":"string",
            "description":"The state name of the address."
        },
        "StateCode":{
            "type":"string",
            "description":"The state abbreviation of the address."
        }
    },
    "description":"Location Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top