CampusAPI Mapping Services API documentation version 0.1.5
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleLocationType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleLocationType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleLocationType%40campusapi.org

• mapId: (string)

  The id string to match a map

  Example:

  mapping.Map%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular location type to create

  Example:

  type.Type%3AexampleLocationType%40dxtera.org

• recordType: (array of )

  specify support for one or more location record types

  Example:

  [
    "type.Type%3AexampleLocationRecordType%40campusapi.org",
    "..."
  ]

• mapId: (string)

  specify in which map to create this location

  Example:

  mapping.Map%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Location",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this location, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this location, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this location for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this location.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this location. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this location. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "spatialUnit": {
      "description": "The spatial unit corresponding to this location.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Location",
  "description": "The description of this Location",
  "spatialUnit": "..SpatialUnit.."
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LocationQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSpatialUnit": {
      "description": "not yet supported",
      "type": "SPATIALUNIT"
    },
    "matchMapIds": {
      "description": "List of Map Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "mapId": {
            "description": "Map id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "mapQueries": {
      "description": "MapQueries to match Map. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular location type to create

  Example:

  type.Type%3AexampleLocationType%40dxtera.org

• recordType: (array of )

  specify support for one or more location record types

  Example:

  [
    "type.Type%3AexampleLocationRecordType%40campusapi.org",
    "..."
  ]

• mapId: (string)

  specify in which map to create this location

  Example:

  mapping.Map%3A8374%40base.url

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "mapping.Location:4946@base.url",
    "uri": "http://base.url/open/campusapi/mapping/location/mapping.Location%3A4946%40base.url",
    "displayName": "Display Name of this Location",
    "description": "The description of this Location",
    "genusTypeId": "type.Type:defaultLocationType@base.url",
    "recordTypeIds": [ "type.Type:exampleLocationRecordType@campusapi.org", "..."],
    "spatialUnit": "..SpatialUnit.."
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• locationId: required(string)

URI Parameters

• locationId: required(string)

URI Parameters

• locationId: required(string)

URI Parameters

• locationId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Location",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this location, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this location, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this location for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this location.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this location. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this location. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "spatialUnit": {
      "description": "The spatial unit corresponding to this location.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Location",
  "description": "The description of this Location",
  "spatialUnit": "..SpatialUnit.."
}

URI Parameters

• locationId: required(string)

URI Parameters

• locationId: required(string)

URI Parameters

• locationId: required(string)

URI Parameters

• locationId: required(string)
• childId: required(string)

URI Parameters

• locationId: required(string)
• childId: required(string)

URI Parameters

• locationId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleMapType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleMapType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleMapType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• locationId: (string)

  Get maps mapped to this location.

  Example:

  mapping.Location%3A168%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular map type to create

  Example:

  type.Type%3AexampleMapType%40dxtera.org

• recordType: (array of )

  specify support for one or more map record types

  Example:

  [
    "type.Type%3AexampleMapRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Map",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this map, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this map, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this map for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this map.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this map. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this map. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this map.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this map. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this map.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Map",
  "description": "The description of this Map",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Map@base.url",
  "license": "The license that applies to this Map"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "MapQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Map with any provider, false to match Map with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Map with any branding, false to match Map with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchMapIds": {
      "description": "List of Map Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "mapId": {
            "description": "Map id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "mapQueries": {
      "description": "MapQueries to match Map. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Map",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this map, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this map, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this map for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Map.Map:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this map",
      "linked": false
    },
    "description": {
      "description": "The description of this map.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Map.Map:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this map",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this map. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this map. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this map.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Map.Map:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this map",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this map. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Map.Map:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this map",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this map.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Map.Map:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this map",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "mapping.Map:4277@base.url",
    "uri": "http://base.url/open/campusapi/mapping/map/mapping.Map%3A4277%40base.url",
    "displayName": "Display Name of this Map",
    "description": "The description of this Map",
    "genusTypeId": "type.Type:defaultMapType@base.url",
    "recordTypeIds": [ "type.Type:exampleMapRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Map@base.url",
    "license": "The license that applies to this Map"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• mapId: required(string)

URI Parameters

• mapId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Map",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this map, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this map, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this map for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this map.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this map. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this map. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this map.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this map. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this map.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Map",
  "description": "The description of this Map",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Map@base.url",
  "license": "The license that applies to this Map"
}

URI Parameters

• mapId: required(string)

URI Parameters

• mapId: required(string)

URI Parameters

• mapId: required(string)

URI Parameters

• mapId: required(string)
• childId: required(string)

URI Parameters

• mapId: required(string)
• childId: required(string)

URI Parameters

• mapId: required(string)

URI Parameters

• mapId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleLocationType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleLocationType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleLocationType%40campusapi.org

URI Parameters

• mapId: required(string)
• locationId: required(string)

URI Parameters

• mapId: required(string)
• locationId: required(string)