Companies

Acquiring documents of resource 'companies'

Document

Property	Type	Contract	Description
_meta	object	required	See documents
name	string	required	Name of company
company_type	string	required	Type of company
location.place_id	string	optional	Google Maps API Place ID of company
location.description	string	optional	Description of company's location
equipment	Array<string>	optional	Equipment guids linked to company
notification_settings_guid	string	optional	Guid of the notification settings document of company

Get companies of resource

GET https://api.v2.myluxura.com/v2/companies/resource

This endpoint will return the resource's companies you're currently authenticated as.

Headers

Name	Type	Description
Authorization	string	Authentication token (type 'Bearer')

200

[
  {
    "_meta": {
      "index": "companies",
      "guid": "<guid>",
      "created": 1618409561738,
      "updated": 1618491831576,
      "removed": 0,
      "expiry": 0,
      "created_by": {
        "host": "myluxura-api",
        "resource": {
          "name": "<name>",
          "guid": "<guid>",
          "index": "<index>"
        }
      }
    },
    "name": "Example company",
    "company_type": "manufacturer-us",
    "location": {
      "place_id": null,
      "description": null
    },
    "equipment": [
      "<guid>"
    ],
    "notification_settings_guid": "<guid>"
  }
]

Get company of resource

GET https://api.v2.myluxura.com/v2/companies/resource/:guid

This endpoint will return the company document of the entered guid, if authenticated resource has permission to do so.

Path Parameters

Name	Type	Description
guid	string	Guid of company document

Headers

Name	Type	Description
Authorization	string	Authentication token (type 'Bearer')

200

{
  "_meta": {
    "index": "companies",
    "guid": "<guid>",
    "created": 1618409561738,
    "updated": 1618491831576,
    "removed": 0,
    "expiry": 0,
    "created_by": {
      "host": "myluxura-api",
      "resource": {
        "name": "<name>",
        "guid": "<guid>",
        "index": "<index>"
      }
    }
  },
  "name": "Example company",
  "company_type": "manufacturer-us",
  "location": {
    "place_id": null,
    "description": null
  },
  "equipment": [
    "<guid>"
  ],
  "notification_settings_guid": "<guid>"
}

Get companies

GET https://api.v2.myluxura.com/v2/companies

This endpoint will return the company's documents.

Query Parameters

Name	Type	Description
company	string	Guid of the company you're acting on behalf of

Headers

Name	Type	Description
Authorization	string	Authentication token (type 'Bearer')

200

[
  {
    "_meta": {
      "index": "companies",
      "guid": "<guid>",
      "created": 1618409561738,
      "updated": 1618491831576,
      "removed": 0,
      "expiry": 0,
      "created_by": {
        "host": "myluxura-api",
        "resource": {
          "name": "<name>",
          "guid": "<guid>",
          "index": "<index>"
        }
      }
    },
    "name": "Example company",
    "company_type": "manufacturer-us",
    "location": {
      "place_id": null,
      "description": null
    },
    "equipment": [
      "<guid>"
    ],
    "notification_settings_guid": "<guid>"
  }
]

Get company

GET https://api.v2.myluxura.com/v2/companies/:guid

This endpoint will return the company's document by guid.

Path Parameters

Name	Type	Description
guid	string	Guid of the company document

Query Parameters

Name	Type	Description
company	string	Guid of the company you're acting on behalf of

Headers

Name	Type	Description
Authorization	string	Authentication token (type 'Bearer')

200

{
  "_meta": {
    "index": "companies",
    "guid": "<guid>",
    "created": 1618409561738,
    "updated": 1618491831576,
    "removed": 0,
    "expiry": 0,
    "created_by": {
      "host": "myluxura-api",
      "resource": {
        "name": "<name>",
        "guid": "<guid>",
        "index": "<index>"
      }
    }
  },
  "name": "Example company",
  "company_type": "manufacturer-us",
  "location": {
    "place_id": null,
    "description": null
  },
  "equipment": [
    "<guid>"
  ],
  "notification_settings_guid": "<guid>"
}

Update company

PATCH https://api.v2.myluxura.com/v2/companies/:guid

This endpoint will update the company's document by guid.

Path Parameters

Name	Type	Description
guid	string	Guid of the company document

Query Parameters

Name	Type	Description
company	string	Guid of the company you're acting on behalf of

Headers

Name	Type	Description
Authorization	string	Authentication token (type 'Bearer')

Request Body

Name	Type	Description
	array	Array of Mutations

200

{
  "_meta": {
    "index": "companies",
    "guid": "<guid>",
    "created": 1618409561738,
    "updated": 1618491831576,
    "removed": 0,
    "expiry": 0,
    "created_by": {
      "host": "myluxura-api",
      "resource": {
        "name": "<name>",
        "guid": "<guid>",
        "index": "<index>"
      }
    }
  },
  "name": "Example company",
  "company_type": "manufacturer-us",
  "location": {
    "place_id": null,
    "description": null
  },
  "equipment": [
    "<guid>"
  ],
  "notification_settings_guid": "<guid>"
}