TMF675 v4 Geographic Location(Outbound)

GET List Geographic Locations

GET /geographicLocation

Display name: Operations for GeographicLocation Resource. Security: clientIdEnforcement.

List or find GeographicLocation objects.

Parameters

• fields (query, string)
• offset (query, string)
• limit (query, string)

Responses

• 200

  Headers:

  • X-Ratelimit-Remaining (number, required) The amount of available quota
    Example: 5.
  • X-Ratelimit-Limit (number, required) The maximum available requests per window
    Example: 10.
  • X-Ratelimit-Reset (number, required) The remaining time, in milliseconds, until a new window starts
    Example: 3000.

  Media type: application/json. Schema: array of object.

  Array of object.

  • id (string)
    Example: 10c5f5b5-e408.
  • href (string)
    Example: https://api.company.com/tmf-api/geographicLocation/v5/geographicLocation/10c5f5b5-e408.
  • name (string)
    Example: Vodafone House.
  • @baseType (string)
    Example: GeographicLocation.
  • @type (string)
    Example: GeoJsonPoint.
  • geoJson (object, required)
    • type (string)
      Example: Point.
    • coordinates (array of number, required)
• 400 Bad request

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "400",
    "reason": "string",
    "message": "Bad Request",
    "status": "string",
    "referenceError": "string"
  }

• 401 Unauthorized

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "401",
    "reason": "string",
    "message": "Unauthorized",
    "status": "string",
    "referenceError": "string"
  }

• 403 Forbidden

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "403",
    "reason": "string",
    "message": "Forbidden",
    "status": "string",
    "referenceError": "string"
  }

• 404 Resource not found

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "404",
    "reason": "string",
    "message": "Not Found",
    "status": "string",
    "referenceError": "string"
  }

• 405 Method not allowed

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "405",
    "reason": "string",
    "message": "Method Not Allowed",
    "status": "string",
    "referenceError": "string"
  }

• 500 Internal server error

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "500",
    "reason": "string",
    "message": "Internal Server Error",
    "status": "string",
    "referenceError": "string"
  }

• 501 Not Implemented

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "501",
    "reason": "string",
    "message": "Not Implemented",
    "status": "string",
    "referenceError": "string"
  }

• 503 Service Unavailable

  Media type: application/json. Schema: any.

  Type: any.

  Example

  {
    "@type": "Error",
    "@baseType": "string",
    "@schemaLocation": "string",
    "code": "503",
    "reason": "string",
    "message": "Service Unavailable",
    "status": "string",
    "referenceError": "string"
  }

• 201

  Headers:

  • X-Ratelimit-Remaining (number, required) The amount of available quota
    Example: 5.
  • X-Ratelimit-Limit (number, required) The maximum available requests per window
    Example: 10.
  • X-Ratelimit-Reset (number, required) The remaining time, in milliseconds, until a new window starts
    Example: 3000.