TMF674 v4 Geographic Site (Outbound)

GET List Geographic Sites

GET /geographicSite

Security: clientIdEnforcement.

List or find GeographicSite objects.

Parameters

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

Responses

200
Media type: application/json. Schema: object.
- id (string)
  Example: sd65-8874.
- href (string)
  Example: https://host:port/geographicSiteManagement/v4/geographicSite/sd65-8874.
- code (string)
  Example: Warehouse.
- description (string)
  Example: Warehouse in Marseille.
- name (string)
  Example: Marseille Warehouse.
- status (string)
  Example: active.
- calendar (array of object, required)
  - day (string)
    Example: weeekdays.
  - status (string)
    Example: open.
  - timeZone (string)
    Example: GMT+1.
  - hourPeriod (array of object, required)
    - endHour (string)
      Example: 16:30 pm.
    - startHour (string)
      Example: 6:30 am.
    - @type (string)
      Example: HourPeriod.
  - @type (string)
    Example: Calendar.
- place (array of object, required)
  - id (string)
    Example: 9912.
  - href (string)
    Example: https://host:port/geographicAddressManagement/v4/geographicAddress/9912.
  - @type (string)
    Example: PlaceRef.
  - @referredType (string)
    Example: GeographicAddress.
- relatedParty (array of object, required)
  - id (string)
    Example: 45.
  - href (string)
    Example: https://host:port/partyManagement/v4/individual/45.
  - name (string)
    Example: Jean Pontus.
  - role (string)
    Example: Warehouse manager.
  - @referredType (string)
    Example: Individual.
- siteRelationship (array of object, required)
  - id (string)
    Example: 4589-jj65.
  - href (string)
    Example: string.
  - relationshipType (string)
    Example: support.
  - role (string)
    Example: support site in case of stock shortage.
  - validFor (object, required)
    - endDateTime (datetime)
      Example: 2019-01-02T09:33:35.749Z.
    - startDateTime (datetime)
      Example: 2023-12-31T09:33:35.749Z.
  - @type (string)
    Example: SiteRelationship.
- @type (string)
  Example: GeographicSite.
Example
```
{
  "id": "sd65-8874",
  "href": "https://host:port/geographicSiteManagement/v4/geographicSite/sd65-8874",
  "code": "Warehouse",
  "description": "Warehouse in Marseille",
  "name": "Marseille Warehouse",
  "status": "active",
  "calendar": [
    {
      "day": "weeekdays",
      "status": "open",
      "timeZone": "GMT+1",
      "hourPeriod": [
        {
          "endHour": "16:30 pm",
          "startHour": "6:30 am",
          "@type": "HourPeriod"
        }
      ],
      "@type": "Calendar"
    }
  ],
  "place": [
    {
      "id": "9912",
      "href": "https://host:port/geographicAddressManagement/v4/geographicAddress/9912",
      "@type": "PlaceRef",
      "@referredType": "GeographicAddress"
    }
  ],
  "relatedParty": [
    {
      "id": "45",
      "href": "https://host:port/partyManagement/v4/individual/45",
      "name": "Jean Pontus",
      "role": "Warehouse manager",
      "@referredType": "Individual"
    }
  ],
  "siteRelationship": [
    {
      "id": "4589-jj65",
      "href": "string",
      "relationshipType": "support",
      "role": "support site in case of stock shortage",
      "validFor": {
        "endDateTime": "2019-01-02T09:33:35.749Z",
        "startDateTime": "2023-12-31T09:33:35.749Z"
      },
      "@type": "SiteRelationship"
    }
  ],
  "@type": "GeographicSite"
}
```

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"
}