Locations

Endpoints related to locations.

GET /location-settings/
Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 404 Not Found – RecordNotFound: Location settings with passed UUID does not exist.

  • 405 Method Not Allowed – NotImplementedError

  • 403 Forbidden – Only a bureau manager or a manager of this location can update location settings.

POST /location-settings/
Status Codes:
Response Headers:

  • Location – URI of the created resource

GET /location-settings/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
PUT /location-settings/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
DELETE /location-settings/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
GET /manufacturer/

Without filters - list all of the manufacturers in the system for user’s bureau.

Without filters - list all of the manufacturers in the system for user’s bureau.

By default - will return all records for Bureau and exclude all templates. If passed is_template == True - will will return only shared between bureaus records and will exclude manufacturers for current user bureau.

Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 404 Not Found – The requested manufacturer cannot be found.

  • 403 Forbidden – Modification of template manufacturer not allowed via API. You are not authorized to complete the request.

  • 400 Bad Request – The requested manufacturer name already exists. DeleteNotAllowed

POST /manufacturer/

Create a new manufacturer.

Create a new manufacturer.

Status Codes:

  • 201 Created – Resource created successfully

  • 404 Not Found – The requested manufacturer cannot be found.

  • 403 Forbidden – Modification of template manufacturer not allowed via API. You are not authorized to complete the request.

  • 400 Bad Request – The requested manufacturer name already exists. DeleteNotAllowed

Response Headers:

  • Location – URI of the created resource

GET /manufacturer/{uuid}/

Get a single manufacturer by UUID. Template (shared) manufacturers not available here - only bureau level.

Get a single manufacturer by UUID. Template (shared) manufacturers not available here - only bureau level.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 200 OK – Successful response

  • 404 Not Found – The requested manufacturer cannot be found.

  • 403 Forbidden – Modification of template manufacturer not allowed via API. You are not authorized to complete the request.

  • 400 Bad Request – The requested manufacturer name already exists. DeleteNotAllowed

PUT /manufacturer/{uuid}/

Update a manufacturer by UUID.

Update a manufacturer by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource updated successfully

  • 404 Not Found – The requested manufacturer cannot be found.

  • 403 Forbidden – Modification of template manufacturer not allowed via API. You are not authorized to complete the request.

  • 400 Bad Request – The requested manufacturer name already exists. DeleteNotAllowed

DELETE /manufacturer/{uuid}/

Delete a manufacturer by UUID.

Delete a manufacturer by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource deleted successfully

  • 404 Not Found – The requested manufacturer cannot be found.

  • 403 Forbidden – Modification of template manufacturer not allowed via API. You are not authorized to complete the request.

  • 400 Bad Request – The requested manufacturer name already exists. DeleteNotAllowed

GET /sub-location/
Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 400 Bad Request – sub-location with the same name already exists.

POST /sub-location/
Status Codes:
Response Headers:

  • Location – URI of the created resource

GET /sub-location/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
PUT /sub-location/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
DELETE /sub-location/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:
GET /location/

List all of the locations in the system for your account.

List all of the locations in the system for your account.

Query Parameters:

  • limit (integer) – Maximum number of resources to return

  • offset (integer) – Number of resources to skip

  • sort (string) – Sort order (prefix with ‘-’ for descending)

Status Codes:

  • 200 OK – Successful response with list of resources

  • 404 Not Found – The requested location cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

  • 400 Bad Request – You cannot change a location’s group. The requested location name already exists. The requested location name already exists. Could not delete location’s group. country code is not ISO-3166 valid There is a mismatch in the bureau of the request and the bureau of the requested resource

POST /location/

Create a new location.

Create a new location.

Status Codes:

  • 201 Created – Resource created successfully

  • 404 Not Found – The requested location cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

  • 400 Bad Request – You cannot change a location’s group. The requested location name already exists. The requested location name already exists. Could not delete location’s group. country code is not ISO-3166 valid There is a mismatch in the bureau of the request and the bureau of the requested resource

Response Headers:

  • Location – URI of the created resource

GET /location/{uuid}/

Get a single location by UUID.

Get a single location by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 200 OK – Successful response

  • 404 Not Found – The requested location cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

  • 400 Bad Request – You cannot change a location’s group. The requested location name already exists. The requested location name already exists. Could not delete location’s group. country code is not ISO-3166 valid There is a mismatch in the bureau of the request and the bureau of the requested resource

PUT /location/{uuid}/

Update a location by UUID.

Update a location by UUID.

Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource updated successfully

  • 404 Not Found – The requested location cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

  • 400 Bad Request – You cannot change a location’s group. The requested location name already exists. The requested location name already exists. Could not delete location’s group. country code is not ISO-3166 valid There is a mismatch in the bureau of the request and the bureau of the requested resource

DELETE /location/{uuid}/
Parameters:

  • uuid (string) – The UUID of the resource

Status Codes:

  • 204 No Content – Resource deleted successfully

  • 404 Not Found – The requested location cannot be found.

  • 403 Forbidden – You are not authorized to complete the request.

  • 400 Bad Request – You cannot change a location’s group. The requested location name already exists. The requested location name already exists. Could not delete location’s group. country code is not ISO-3166 valid There is a mismatch in the bureau of the request and the bureau of the requested resource