Location group members

Location group member represents a location in a location group.

List location group members

get/objects/company-config/location-group-member

Returns a collection with a key, ID, and link for each location group member. This operation is mostly for use in testing; use the query service to find location group members that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/location-group-member/1"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/location-group-member/3"
      },
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/company-config/location-group-member/13"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a location group member
get/objects/company-config/location-group-member/{key}
Returns detailed information for a particular location group member.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the location group member.


 
 Example:  13
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "13",
    • "id": "13",
    • "locationGroup": {
      • "id": "6",
      • "key": "6",
      • "href": "/objects/company-config/location-group/6"
      },
    • "location": {
      • "key": "1",
      • "id": "1",
      • "name": "United States of America",
      • "href": "/objects/company-config/location/1"
      },
    • "sortOrder": 0,
    • "audit": {
      • "createdDateTime": "2018-05-01T22:37:18Z",
      • "modifiedDateTime": "2018-05-01T22:37:18Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/company-config/location-group-member/13",
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}