Show Source

• [0]: object ApiEntityLocation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityLocation"
    }
}

Show Source

• addressLine1(optional): string
  Allowed Values: [ "Length[1-200]" ]

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2(optional): string
  Allowed Values: [ "Length[1-200]" ]

  The second line of the address of a location.
  This might be a neighborhood or town.
• cityName(optional): string
  Allowed Values: [ "Length[1-200]" ]

  The city name for a location.
• countryCode(optional): string
  Allowed Values: [ "Length[1-3]" ]

  The country for a location. The value is expressed as a three letter code.
• description(optional): string
  Additional details about the location.
• latitude(optional): number(double)
  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• link(optional): string(url)
  Read Only: true
• locationCode: string
  Allowed Values: [ "Length[1-60]" ]

  The unique identifier for the location.
• locationId: integer(int64)
  The unique identifier for the location.
• locationName: string
  Allowed Values: [ "Length[1-255]" ]

  A name for the location that your users will understand and recognize.
• longitude(optional): number(double)
  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• postalCode(optional): string
  Allowed Values: [ "Length[1-20]" ]

  The postal code, post code, or zip code of a location.
• stateCode(optional): string
  Allowed Values: [ "Length[1-2]" ]

  A unique identifier for the state or province.
• stateName(optional): string
  Allowed Values: [ "Length[1-200]" ]

  The state, region, or province of a location.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceId(optional): integer(int64)

{
    "type":"object",
    "required":[
        "locationCode",
        "locationId",
        "locationName"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64"
        },
        "description":{
            "type":"string",
            "description":"Additional details about the location."
        },
        "locationId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the location."
        },
        "locationCode":{
            "type":"string",
            "description":"The unique identifier for the location.",
            "enum":[
                "Length[1-60]"
            ]
        },
        "countryCode":{
            "type":"string",
            "description":"The country for a location. The value is expressed as a three letter code.",
            "enum":[
                "Length[1-3]"
            ]
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "enum":[
                "Length[1-200]"
            ]
        },
        "stateName":{
            "type":"string",
            "description":"The state, region, or province of a location.",
            "enum":[
                "Length[1-200]"
            ]
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "enum":[
                "Length[1-200]"
            ]
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "enum":[
                "Length[1-20]"
            ]
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "locationName":{
            "type":"string",
            "description":"A name for the location that your users will understand and recognize.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "cityName":{
            "type":"string",
            "description":"The city name for a location.",
            "enum":[
                "Length[1-200]"
            ]
        },
        "stateCode":{
            "type":"string",
            "description":"A unique identifier for the state or province.",
            "enum":[
                "Length[1-2]"
            ]
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}