{"info":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","description":"

The following documentation is for the ONARKEN Smart Lockers API.

\n

If you have any questions, or experiece any issues when using the API please contact the LapSafe® Support team by emailing support@lapsafe.com

\n

Authorisation

\n

The ONARKEN API is authenticated by setting an Authorization header with a Bearer token, the API token is provided by ONARKEN.

\n

How to get an API Token

\n

To start using the API you will need to get an API token. API tokens are scoped to your user account. Any actions performed using the API will be recognised by your user account and will abide by your permissions.

\n
    \n

  1. Click your name to open the profile drop down menu

    \n
    2. \n

  2. Click Profile

    \n
    3. \n

  3. At the API tokens section

    \n
    4. \n

  4. Click New personal access token

    \n
    5. \n

  5. Enter a recognisable name for the token

    \n
    6. \n

  6. Click Create token

    \n
    7. \n
\n

An API token will be shown to you on screen, you should keep this safe and private, ONARKEN® will not show you this token again.

\n

Webhooks

\n

ONARKEN can automatically notify a third party system when certain events occur at the Smart Lockers. This system is called webhooks, follow the steps below to enable Webhooks.

\n
    \n

  1. Click Setttings from the main navigation

    \n
    2. \n

  2. Go to the Webhooks section

    \n
    3. \n

  3. Enter the URL that you would like ONARKEN to send requests to

    \n
    4. \n

  4. Select the webhook subscriptions the third party system should be notified for

    \n
    5. \n

  5. Click Save

    \n
    6. \n
\n

Verifying Received Webhooks

\n

When handling incoming webhooks, you should confirm that the request genuinely originates from ONARKEN® and that its contents have not been altered.

\n

To do this

\n
    \n

  1. Generate an HMAC-SHA256 signature (hexadecimal encoded) using the webhook payload and the secret key provided during webhook configuration.

    \n
    2. \n

  2. Compare the generated signature with the Signature header included in the webhook request.

    \n
    3. \n
\n

If the two values match, the request can be considered authentic. If they do not, the payload may have been tampered with or the request may have come from an untrusted source.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authorisation","slug":"authorisation"},{"content":"Webhooks","slug":"webhooks"}],"owner":"40419223","collectionId":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","publishedId":"2sAYXBFerL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ea6fb3"},"publishDate":"2025-02-12T10:51:25.000Z"},"item":[{"name":"Loaning","item":[{"name":"Bookings","item":[{"name":"Individual Booking","item":[{"name":"Retrieve a booking","id":"15f71e53-a688-4f07-bdd4-c84ddbf27ab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bookings/:id","description":"

Get a single booking by its ID

\n","urlObject":{"path":["bookings",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"82212932-b8f8-4fad-94b5-7cd49ea59c18","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b8b09f10-1af3-4a87-9138-432e23a52a38","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"booking\": {\n \"id\": \"\",\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\",\n \"booked_from\": \"\",\n \"booked_until\": \"\"\n }\n}"},{"id":"df8de986-ec5c-43d2-bf17-c08f7d0d5cad","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6433f75e-81f8-40d1-9a75-bf6b6a2108ff","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"40cd75bf-fc22-4c68-bcd3-267c83e574a2","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"15f71e53-a688-4f07-bdd4-c84ddbf27ab5"},{"name":"Cancel a Booking","id":"2b7c1da8-8aea-4005-b09e-3524976b60d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bookings/:id","description":"

Cancel an existing booking

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the booking to be cancelled
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bookings",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1a2fc89a-3f29-4b3a-a9c9-da0d371cb083","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"13df95d5-925f-47ff-9b5c-e35c97350182","name":"Bad Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"88f8816a-7ef8-484e-ab60-2bfe606f63d3","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a2822137-7c4f-40ff-9b1c-45b495061f4a","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"2b7c1da8-8aea-4005-b09e-3524976b60d5"},{"name":"Get allocated bays for booking","id":"0a79a865-005f-49a4-82b3-df798bae3aea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bookings/:id/allocations","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bookings",":id","allocations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"b4478f99-27ce-463b-85e8-db7bfb8a9676","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d56eb404-3d25-4247-a234-9949f1888e4e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/allocations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","allocations"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"booking_allocations\": [\n {\n \"id\": \"\",\n \"booking_id\": \"\",\n \"bay_id\": \"\",\n \"has_been_held\": true,\n \"user_id\": \"\",\n \"loan_id\": \"\",\n \"held_at\": \"\"\n },\n {\n \"id\": \"\",\n \"booking_id\": \"\",\n \"bay_id\": \"\",\n \"has_been_held\": true,\n \"user_id\": \"\",\n \"loan_id\": \"\",\n \"held_at\": \"\"\n }\n ]\n}"},{"id":"cabb526b-5e52-49db-93ef-04b8e5021071","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/allocations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","allocations"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"99ade9bb-dd7f-4608-be49-4b5010b0cfab","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/allocations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","allocations"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4f28331f-d5e7-4be4-984b-4d95c27f1ac9","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/allocations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","allocations"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"0a79a865-005f-49a4-82b3-df798bae3aea"},{"name":"Release Booking Allocations","id":"356cd551-4ffd-4670-a4f3-ea614286b80b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bookings/:id/release","description":"

Release all bays that have been booked into the general loan pool

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringNoThe unique UUID of the booking that is being released.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bookings",":id","release"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"912b1e2e-fe95-4d2f-b461-6fb2cdae5044","name":"No Content","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/release","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","release"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7c445408-231a-4aa5-9cff-a206531711a4","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/release","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","release"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0b94b150-ad4d-44e5-9ce8-ed8d4b721663","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/release","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","release"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7c356164-dba6-428d-ba9e-81f96ee3da17","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/:id/release","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings",":id","release"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"356cd551-4ffd-4670-a4f3-ea614286b80b"}],"id":"47f12bcb-c258-445b-9742-fcecbdf3f1a5","_postman_id":"47f12bcb-c258-445b-9742-fcecbdf3f1a5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Bookings","id":"e69456b2-faf7-487b-b66c-6920c1d9ac1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bookings","description":"

Retrieve a list of bookings

\n","urlObject":{"path":["bookings"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

Include past bookings

\n","type":"text/plain"},"key":"filter[include_past]","value":"false"},{"disabled":true,"description":{"content":"

Filter bookings by user

\n","type":"text/plain"},"key":"filter[user_id]","value":""}],"variable":[]}},"response":[{"id":"aaef2b32-c713-4970-b2b9-246ae7e727d5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings?filter[include_past]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings"],"query":[{"description":"Include past bookings","key":"filter[include_past]","value":"false"},{"description":"Filter bookings by user","key":"filter[user_id]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"bookings\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\",\n \"booked_from\": \"\",\n \"booked_until\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\",\n \"booked_from\": \"\",\n \"booked_until\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"4b67c99c-2f73-4375-84ca-ac568b6a4d6f","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings?filter[include_past]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings"],"query":[{"description":"Include past bookings","key":"filter[include_past]","value":"false"},{"description":"Filter bookings by user","key":"filter[user_id]","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0fcf4ca3-a514-4ee9-86cd-a7c11be3fb63","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings?filter[include_past]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings"],"query":[{"description":"Include past bookings","key":"filter[include_past]","value":"false"},{"description":"Filter bookings by user","key":"filter[user_id]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"e69456b2-faf7-487b-b66c-6920c1d9ac1c"},{"name":"Make a Booking","id":"559f6df4-fb87-4811-a4c0-ae49fbdf719c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bookings","description":"

Make a new booking

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
user_idstringNoThe user's unique UUID for this transaction.
location_idstringYesThe UUID of the location that you would like the user to book an asset from
asset_type_idstringYesThe unique asset type UUID that is being booked
quantityintYesThe amount of assets being booked
booking_datedateYesThe date that the booking is required for.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bookings"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"52098152-55e6-4b17-8b22-a56176f4850f","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bookings"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"booking\": {\n \"id\": \"\",\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\",\n \"booked_from\": \"\",\n \"booked_until\": \"\"\n }\n}"},{"id":"742b758a-d55b-4387-9218-f83094c1a116","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bookings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ed714ee8-c808-48f1-b0e0-38ae377de22e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bookings"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"cff262cb-133f-490d-a653-2a61446a0dc2","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"location_id\": \"\",\n \"asset_type_id\": \"\",\n \"quantity\": \"\",\n \"booking_date\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bookings"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"559f6df4-fb87-4811-a4c0-ae49fbdf719c"},{"name":"List Booking Availability","id":"ef01e256-c179-4bbc-a61f-58c3a6396eb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bookings/availability","description":"

This endpoint shows availability for asset types based on a date provided

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bookings","availability"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"date","value":""}],"variable":[]}},"response":[{"id":"745c255c-6c0b-4a74-9f69-605f17ef11bf","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bookings/availability?date=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bookings","availability"],"query":[{"description":"(Required) ","key":"date","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"asset_types\": [\n {\n \"id\": \"\",\n \"count\": \"\"\n },\n {\n \"id\": \"\",\n \"count\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"asset_types\": [\n {\n \"id\": \"\",\n \"count\": \"\"\n },\n {\n \"id\": \"\",\n \"count\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"ef01e256-c179-4bbc-a61f-58c3a6396eb0"}],"id":"be694612-19cf-4891-bd11-2a514741fa28","_postman_id":"be694612-19cf-4891-bd11-2a514741fa28","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Fines","item":[{"name":"Individual Fine","item":[{"name":"Get a Fine","id":"87ccbbe8-d861-46a3-b038-f9372ed0b3d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/fines/:id","description":"

Retrieve a single fine by its uuid

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["fines",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"cfc8944f-c5d4-425b-98b9-c6ad75550c82","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"81a1b4d2-c4b7-448c-b7b8-18134555b25f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"fine\": {\n \"id\": \"\",\n \"user_id\": \"\",\n \"loan_id\": \"\",\n \"fine_amount\": \"\",\n \"has_been_paid\": \"\",\n \"paid_at\": \"\",\n \"fine_issued_at\": \"\"\n }\n}"},{"id":"9925117c-50ae-43f7-a1b2-e4edea1242e8","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ed24ba5e-879a-4431-b72d-ab16d831eb15","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f7aed58e-3086-4067-8b8e-f2235de93dd7","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"87ccbbe8-d861-46a3-b038-f9372ed0b3d1"},{"name":"Mark a Fine Paid","id":"70820083-873c-42a4-a326-c18319e90152","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/fines/:id/pay","description":"

Mark an unpaid fine as paid

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the fine to be marked as paid
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["fines",":id","pay"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"ba81b660-1469-4d16-b89e-7bd69d34fa4c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"da77166a-4a45-4ff7-b0af-9cf1d914b55e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id/pay","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id","pay"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"fine\": {\n \"id\": \"\",\n \"user_id\": \"\",\n \"loan_id\": \"\",\n \"fine_amount\": \"\",\n \"has_been_paid\": \"\",\n \"paid_at\": \"\",\n \"fine_issued_at\": \"\"\n }\n}"},{"id":"46626f28-2f3e-4fef-b995-86706ee223f7","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id/pay","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id","pay"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f299f805-9f2f-46b8-9513-c6f6583102ad","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id/pay","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id","pay"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6b42e7fa-8494-4ded-841c-c6bcf3f5952c","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id/pay","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id","pay"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9f6e387f-c87a-451a-9dba-459f0b4808a8","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines/:id/pay","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines",":id","pay"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"70820083-873c-42a4-a326-c18319e90152"}],"id":"03d079eb-02c6-4c70-b29c-c43dd8f0495b","_postman_id":"03d079eb-02c6-4c70-b29c-c43dd8f0495b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Fines","id":"9b1778f7-768d-428b-a47d-c621bab05a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/fines?filter[include_paid]=false&filter[user_id]=","description":"

Get a list of all fines, the default only includes fines that have not been paid

\n","urlObject":{"path":["fines"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"description":{"content":"

Include paid fines

\n","type":"text/plain"},"key":"filter[include_paid]","value":"false"},{"description":{"content":"

Filter the fines by a user id

\n","type":"text/plain"},"key":"filter[user_id]","value":""}],"variable":[]}},"response":[{"id":"7d300fc8-c810-49b3-a98d-a0a1235c38c8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines?filter[include_paid]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines"],"query":[{"description":"Include paid fines","key":"filter[include_paid]","value":"false"},{"description":"Filter the fines by a user id","key":"filter[user_id]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"fines\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"loan_id\": \"\",\n \"fine_amount\": \"\",\n \"has_been_paid\": \"\",\n \"paid_at\": \"\",\n \"fine_issued_at\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"loan_id\": \"\",\n \"fine_amount\": \"\",\n \"has_been_paid\": \"\",\n \"paid_at\": \"\",\n \"fine_issued_at\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"2807fd57-ef0f-44a2-966c-663e96200d02","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines?filter[include_paid]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines"],"query":[{"description":"Include paid fines","key":"filter[include_paid]","value":"false"},{"description":"Filter the fines by a user id","key":"filter[user_id]","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"fdec39c0-d2e1-43ac-8747-53c913f2a3dd","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines?filter[include_paid]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines"],"query":[{"description":"Include paid fines","key":"filter[include_paid]","value":"false"},{"description":"Filter the fines by a user id","key":"filter[user_id]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"074a6955-4316-459c-a54a-bb6738603d38","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/fines?filter[include_paid]=false&filter[user_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["fines"],"query":[{"description":"Include paid fines","key":"filter[include_paid]","value":"false"},{"description":"Filter the fines by a user id","key":"filter[user_id]","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"9b1778f7-768d-428b-a47d-c621bab05a16"}],"id":"a93b0241-090f-4ab6-8a0f-8f056b0baae7","_postman_id":"a93b0241-090f-4ab6-8a0f-8f056b0baae7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Loans","id":"7399dd40-7f15-49af-92dc-413bba5337f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/loans","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["loans"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

Filter the loans that were started before a date

\n","type":"text/plain"},"key":"filter[loaned_before]","value":""},{"disabled":true,"description":{"content":"

Filter the loans that were started after a date

\n","type":"text/plain"},"key":"filter[loaned_after]","value":""},{"disabled":true,"description":{"content":"

Filter the loans that are due before a date

\n","type":"text/plain"},"key":"filter[due_before]","value":""},{"disabled":true,"description":{"content":"

Filter the loans that are due after a date

\n","type":"text/plain"},"key":"filter[due_after]","value":""},{"disabled":true,"description":{"content":"

Filter the loans that were returned before a date

\n","type":"text/plain"},"key":"filter[returned_before]","value":""},{"disabled":true,"description":{"content":"

Filter the loans that were returned after a date

\n","type":"text/plain"},"key":"filter[returned_after]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only loans from certain user UUIDs

\n","type":"text/plain"},"key":"filter[user_id]","value":"|"},{"disabled":true,"description":{"content":"

Filter loans to only loans from certain bay UUIDs

\n","type":"text/plain"},"key":"filter[bay_id]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only loans from certain installations UUIDs

\n","type":"text/plain"},"key":"filter[installation_id]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only loans from certain asset IDs

\n","type":"text/plain"},"key":"filter[asset_id]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only loans from certain Asset Type IDs

\n","type":"text/plain"},"key":"filter[asset_type_id]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only include loans that are currently overdue

\n","type":"text/plain"},"key":"filter[overdue]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only include loans that have been returned

\n","type":"text/plain"},"key":"filter[returned]","value":""},{"disabled":true,"description":{"content":"

Filter loans to only include loans that have been returned late

\n","type":"text/plain"},"key":"filter[returned_late]","value":""}],"variable":[]}},"response":[{"id":"843e2339-7743-45ed-a4d5-ecf7b45e9808","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/loans?filter[loaned_before]=&filter[loaned_after]=&filter[due_before]=&filter[due_after]=&filter[returned_before]=&filter[returned_after]=&filter[user_id]=|&filter[bay_id]=&filter[installation_id]=&filter[asset_id]=&filter[asset_type_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["loans"],"query":[{"description":"Filter the loans that were started before a date","key":"filter[loaned_before]","value":""},{"description":"Filter the loans that were started after a date","key":"filter[loaned_after]","value":""},{"description":"Filter the loans that are due before a date","key":"filter[due_before]","value":""},{"description":"Filter the loans that are due after a date","key":"filter[due_after]","value":""},{"description":"Filter the loans that were returned before a date","key":"filter[returned_before]","value":""},{"description":"Filter the loans that were returned after a date","key":"filter[returned_after]","value":""},{"description":"Filter loans to only loans from certain user UUIDs","key":"filter[user_id]","value":"|"},{"description":"Filter loans to only loans from certain bay UUIDs","key":"filter[bay_id]","value":""},{"description":"Filter loans to only loans from certain installations UUIDs","key":"filter[installation_id]","value":""},{"description":"Filter loans to only loans from certain asset IDs","key":"filter[asset_id]","value":""},{"description":"Filter loans to only loans from certain Asset Type IDs","key":"filter[asset_type_id]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"loans\": [\n {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"requested_at\": \"\",\n \"asset_id\": \"\",\n \"user_id\": \"\",\n \"loaned_at\": \"\",\n \"due_at\": \"\",\n \"returned_at\": \"\",\n \"cancelled_at\": \"\"\n },\n {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"requested_at\": \"\",\n \"asset_id\": \"\",\n \"user_id\": \"\",\n \"loaned_at\": \"\",\n \"due_at\": \"\",\n \"returned_at\": \"\",\n \"cancelled_at\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"58a768c1-7ad2-4456-8ca0-8fe64920e8a6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/loans?filter[loaned_before]=&filter[loaned_after]=&filter[due_before]=&filter[due_after]=&filter[returned_before]=&filter[returned_after]=&filter[user_id]=|&filter[bay_id]=&filter[installation_id]=&filter[asset_id]=&filter[asset_type_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["loans"],"query":[{"description":"Filter the loans that were started before a date","key":"filter[loaned_before]","value":""},{"description":"Filter the loans that were started after a date","key":"filter[loaned_after]","value":""},{"description":"Filter the loans that are due before a date","key":"filter[due_before]","value":""},{"description":"Filter the loans that are due after a date","key":"filter[due_after]","value":""},{"description":"Filter the loans that were returned before a date","key":"filter[returned_before]","value":""},{"description":"Filter the loans that were returned after a date","key":"filter[returned_after]","value":""},{"description":"Filter loans to only loans from certain user UUIDs","key":"filter[user_id]","value":"|"},{"description":"Filter loans to only loans from certain bay UUIDs","key":"filter[bay_id]","value":""},{"description":"Filter loans to only loans from certain installations UUIDs","key":"filter[installation_id]","value":""},{"description":"Filter loans to only loans from certain asset IDs","key":"filter[asset_id]","value":""},{"description":"Filter loans to only loans from certain Asset Type IDs","key":"filter[asset_type_id]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"7399dd40-7f15-49af-92dc-413bba5337f5"},{"name":"Current Loaning Availability Statistics","id":"cfe25625-181c-4947-bc8f-c6d77e81b166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/availability","urlObject":{"path":["availability"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"72066afb-5750-489f-8374-2180d257e091","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/availability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\",\n \"installations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\",\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\",\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"total_loanable_assets\": \"\",\n \"total_loanable_assets_available\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"cfe25625-181c-4947-bc8f-c6d77e81b166"},{"name":"Retrieve a Loan","id":"d5501755-a186-4695-b0c6-9e2c1cbfde45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/loans/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["loans",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"cb170b45-4a19-4287-b0f2-b62d44623681","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8a63233f-f468-4381-9132-fecca2df596e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/loans/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["loans",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"loan\": {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"requested_at\": \"\",\n \"asset_id\": \"\",\n \"user_id\": \"\",\n \"loaned_at\": \"\",\n \"due_at\": \"\",\n \"returned_at\": \"\",\n \"cancelled_at\": \"\"\n }\n}"},{"id":"d7219224-0dc1-46c2-9cce-0076ec2fa639","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/loans/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["loans",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2bcc1e69-9241-47a1-9489-831d7402fbfb","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/loans/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["loans",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d5501755-a186-4695-b0c6-9e2c1cbfde45"}],"id":"2b8bad76-46bc-4b9a-95bc-e3bad4c28e73","description":"

All requests in this section pertain specifically to the Loaning service.

\n

Only Smart Locker bays that are explicitly configured for Loaning are eligible for use with this service.

\n","_postman_id":"2b8bad76-46bc-4b9a-95bc-e3bad4c28e73","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Drop Off & Collection","item":[{"name":"Drop Offs","item":[{"name":"Individual Drop Off","item":[{"name":"Retrieve a Single Drop Off","id":"d082b3a2-4da8-4994-8b6f-29d26b628968","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id","description":"

Get a single drop off

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["drop_offs",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"c8db62f5-0868-4742-8781-ce295a44d362","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"81f16caf-6ab6-46f0-8f68-918c336c078c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"drop_off\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"reason_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"dropped_off_at\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"ExtraSmall\",\n \"charging_type\": \"ChargeLine\",\n \"connectivity_equipment\": \"DataTransfer\"\n }\n }\n}"},{"id":"67fe546a-e7d2-4398-8fc3-3e13079a147f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"626e8a67-e620-4aa6-af53-b037efa7759b","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d082b3a2-4da8-4994-8b6f-29d26b628968"},{"name":"Cancel a Drop Off","id":"d64489ba-da05-4746-b256-7612964ae05b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/cancel","description":"

Cancel a pending drop off

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["drop_offs",":id","cancel"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"cc2d0659-d8d6-4cd5-91b9-e80fbd055f6b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"06338ced-b168-45b2-bd09-ac51bab7f41e","name":"No Content","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","cancel"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"be7fb9a7-614d-4d9c-a508-4af64bc2e0ea","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e91b8fa5-2073-484f-a15c-464978a2f08b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"befcc0a7-1e37-4748-9250-61181d35e703","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"dc8f4cb1-8685-4369-856f-6e6931d21944","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d64489ba-da05-4746-b256-7612964ae05b"},{"name":"Complete a Drop Off","id":"66a2d43b-7ef3-4947-b4a3-36885693548d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dropped_off_at\": \"\",\n \"transaction_id\": \"\",\n \"bay_id\": \"\",\n \"rejections\": []\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/complete","description":"

This endpoint will mark a Drop Off as completed.

\n

This should be used for testing purposes when using real lockers is not practical

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["drop_offs",":id","complete"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

ID of the Drop Off to Complete

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"aff5a472-115a-4e67-a9b0-675305103021","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"dropped_off_at\": \"\",\n \"transaction_id\": \"\",\n \"bay_id\": \"\",\n \"rejections\": [\n {\n \"reason\": \"Size\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n },\n {\n \"reason\": \"Dirty\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","complete"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"drop_off\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"dropped_off_at\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"ExtraSmall\",\n \"charging_type\": \"ChargeLine\",\n \"connectivity_equipment\": \"DataTransfer\"\n }\n }\n}"},{"id":"2121ec51-b4cb-40fd-ab70-afaeb4b83bd3","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"dropped_off_at\": \"\",\n \"transaction_id\": \"\",\n \"bay_id\": \"\",\n \"rejections\": [\n {\n \"reason\": \"Size\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n },\n {\n \"reason\": \"Dirty\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","complete"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0a23f2eb-8f40-43a4-a3c0-72f6eaa04f2f","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"dropped_off_at\": \"\",\n \"transaction_id\": \"\",\n \"bay_id\": \"\",\n \"rejections\": [\n {\n \"reason\": \"Size\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n },\n {\n \"reason\": \"Dirty\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","complete"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c78ee84f-1980-411f-95c8-7d782bb20386","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"dropped_off_at\": \"\",\n \"transaction_id\": \"\",\n \"bay_id\": \"\",\n \"rejections\": [\n {\n \"reason\": \"Size\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n },\n {\n \"reason\": \"Dirty\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","complete"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a1fd5442-ab33-47e7-8d12-d4c6e89978a8","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"dropped_off_at\": \"\",\n \"transaction_id\": \"\",\n \"bay_id\": \"\",\n \"rejections\": [\n {\n \"reason\": \"Size\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n },\n {\n \"reason\": \"Dirty\",\n \"bay_id\": \"\",\n \"notes\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","complete"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"66a2d43b-7ef3-4947-b4a3-36885693548d"},{"name":"Get Code for Drop Off","id":"29157fed-b516-40bd-a93a-010d547ea69f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/code","description":"

Get the code for a Drop Off

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["drop_offs",":id","code"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"e6d2598a-53d1-4a7d-89c8-f6b9fcff2dc7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f16ff5b5-889e-4568-b445-546c0ba1d835","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","code"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"},{"id":"f102936c-14e1-4556-818d-c5ffc61efdd9","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","code"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"46737958-5921-499a-a21a-4bfdf47bb83c","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","code"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9e5f2c7d-cddc-44b4-9288-c55793fcbdee","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/drop_offs/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["drop_offs",":id","code"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"29157fed-b516-40bd-a93a-010d547ea69f"}],"id":"ad0e13a7-2547-40f9-bb6a-270c2b28d0cb","_postman_id":"ad0e13a7-2547-40f9-bb6a-270c2b28d0cb","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Drop Offs","id":"ccaf2a2e-cae4-4cc0-8f53-f016cdec3b79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/drop_offs","description":"

Get a list of drop offs

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["drop_offs"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9c429b02-440d-4087-a0ed-59dcb4307e70","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":"https://{{domain}}.onarken.com/api/v1/drop_offs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"drop_offs\": [\n {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"reason_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"dropped_off_at\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Medium\",\n \"charging_type\": \"SmartLine\",\n \"connectivity_equipment\": \"DataTransfer\"\n }\n },\n {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"dropped_off_at\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"ExtraLarge\",\n \"charging_type\": \"ChargeLine\",\n \"connectivity_equipment\": \"DataTransfer\"\n }\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"}],"_postman_id":"ccaf2a2e-cae4-4cc0-8f53-f016cdec3b79"},{"name":"Arrange Drop Off","id":"dd0dc8f9-e0c6-4839-aceb-6ac65b7748ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"reason_id\": \"\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n },\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs","description":"

Create a drop off

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
user_idstringNoThe user's unique UUID for this transaction.
installation_idstringYesThe UUID of the installation that you would like the user to drop off an asset to
asset_idstringWithout asset_descriptionThe unique asset reference / ID that is being dropped off.

Not required when using asset_description
asset_descriptionstringWithout asset_idA description of the asset being dropped off.

Not required when using asset_id
transition_asset_to_statusstring
one of
- EndOfLife
- Deployable
- Service		NoDepreciated

Reason for drop off
reason_idstringNoThe UUID of a reason in ONARKEN for this Drop Off.
bay_requirements.minimum_sizestring
one of
- ExtraSmall
- Small
- Medium
- Large
- ExtraLarge
- ExtraLarge		NoThe minimum size locker that should be provided for this drop off
bay_requirements.connectivity_equipmentstring
one of
- None
- DataTransfer
- KVM		NoConnectivity equipment required in lockers for this drop off
with_collection_forarrayNoArray of User UUIDs that a collection should automatically be raised for when drop off has been completed.

Do not send property if no immediate user assigned collection is required
extension_attributesarrayNoArray of keys and values of extension attributes and their assigned values.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["drop_offs"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5487ae5b-15ec-4984-8966-933201c1dc56","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n },\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"drop_off\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"reason_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"dropped_off_at\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"ExtraSmall\",\n \"charging_type\": \"ChargeLine\",\n \"connectivity_equipment\": \"DataTransfer\"\n },\n \"extension_attributes\": {\n \"extension_attribute_key\": \"\"\n }\n }\n}"},{"id":"e0c3e93c-6ab8-4c86-8998-5b01d3e15e13","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n },\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"5c611d37-5c9d-46b8-82f1-519e93896872","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n },\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0b1de22a-663b-4d21-a5b6-b678c9c00bf1","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n },\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e56b2906-0707-4cfb-b5fd-b9f42f8a61ed","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"\",\n \"installation_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n },\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/drop_offs"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"dd0dc8f9-e0c6-4839-aceb-6ac65b7748ae"}],"id":"eb238c95-a183-4abb-9c7a-902580517594","_postman_id":"eb238c95-a183-4abb-9c7a-902580517594","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Collections","item":[{"name":"Individual Collection","item":[{"name":"Retrieve a Collection","id":"58514adb-9d9e-4a40-ab37-a0575389ea13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/collections/:id","description":"

Get a collection

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["collections",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"e3d1d139-8af7-465a-946d-cc8e7c66d7c5","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"771df36b-b686-4fb9-b632-1db5ba26c9da","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"collection\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"expires_at\": \"\",\n \"collected_at\": \"\"\n }\n}"},{"id":"0fca95fb-5a4f-4ce0-8404-a34eddd8b3a9","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9098443f-c892-4ab2-8d93-10aef401b28f","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"58514adb-9d9e-4a40-ab37-a0575389ea13"},{"name":"Cancel a Collection","id":"6754df86-cc10-43d5-8da4-8157690f49c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/collections/:id/cancel","description":"

Cancel a pending collection

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the collection to be cancelled
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["collections",":id","cancel"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d062ddb6-0194-4574-8e67-745d18c693c1","name":"No Content","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","cancel"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"440a9dfc-ece7-4941-b841-ab2352266dbf","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"09d60089-54c0-4032-9846-6b9a763d387d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"d103adc3-f929-4a1a-be0f-d91830e6b267","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2ecafd11-c867-41f2-ba88-a7dce6783a2c","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"6754df86-cc10-43d5-8da4-8157690f49c9"},{"name":"Complete a Collection","id":"5a31823c-0488-4d7f-a931-4690f5bc138f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"collected_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections/:id/complete","description":"

This endpoint will mark a pending collection as collected.

\n

This should be used for testing purposes when using real lockers is not practical

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the collection to complete
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
collected_atdateYesThe date that the collection was successfully collected at
transaction_idstringYesThe unique UUID of the transaction for the collection
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["collections",":id","complete"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the collection

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6a61e4b5-eef0-475b-a6b6-ccf0bcddf8ed","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"collected_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","complete"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"collection\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"expires_at\": \"\",\n \"collected_at\": \"\"\n }\n}"},{"id":"840cd1f3-f1a3-4148-8292-0b68b973a687","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"collected_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","complete"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f583b57c-8e75-48e1-be05-07d6e76d4f0b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"collected_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","complete"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4cf75bec-02a5-4134-b4ff-e762f3c30a0b","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"collected_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","complete"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a983b694-5f28-4ff2-bd95-4fe2b16ce721","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"collected_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","complete"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"5a31823c-0488-4d7f-a931-4690f5bc138f"},{"name":"Get Code for Collection","id":"91985ad5-ab0f-4531-9658-d0857785b3c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/collections/:id/code","description":"

Get the code for a collection

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["collections",":id","code"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"99c13107-215e-406e-bb52-010896fc68de","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0f83533d-b663-4683-92b0-b139a83ee35a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","code"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"},{"id":"c29c88f6-50d5-44b7-a44c-fe7c0cf2480e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","code"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6f826643-96ee-488a-bef1-3fb755d67550","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","code"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2f39b227-7803-4e38-9c06-d85ba4240788","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections",":id","code"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"91985ad5-ab0f-4531-9658-d0857785b3c5"}],"id":"b6400583-8450-439f-b726-80661e9d43a1","_postman_id":"b6400583-8450-439f-b726-80661e9d43a1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Collections","id":"15539887-275a-4757-a32e-3bdf28797f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/collections","description":"

Get a list of collections

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["collections"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3c28dfcc-32a7-4428-8137-903806f1449e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"collections\": [\n {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"status\": \"AwaitingDropOff\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"expires_at\": \"\",\n \"collected_at\": \"\"\n },\n {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"status\": \"AwaitingDropOff\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"expires_at\": \"\",\n \"collected_at\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"06943b90-44cc-42b3-b4f4-27cd1dd3e209","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"15539887-275a-4757-a32e-3bdf28797f06"},{"name":"Arrange Collection","id":"2327a28c-f03e-4768-83bb-866f5d016ffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"expires_at\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections","description":"

Create a new collection

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
userarrayNoAn optional array of users unique UUID's that can be assigned to the collection
bay_idstringYesThe unique UUID of the bay that the collection is to be arranged from
expires_atdateNoAn optional automatic expirary date for the collection
extension_attributesarrayNoAn optional array of extension attributes to assign to the collection
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["collections"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b1b8a9b9-25e9-4f84-a8ce-1774e458b704","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"expires_at\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"collection\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"expires_at\": \"\",\n \"collected_at\": \"\"\n }\n}"},{"id":"3c64d0ff-7a61-4b31-b325-3e4803468bde","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"expires_at\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"94739c82-9383-457d-898f-f7942117994e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"expires_at\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6e887950-4793-436f-ba45-563f26657d02","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"expires_at\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ad0792b3-b81b-4a66-bdc0-7e01ce32b4cc","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"users\": [\n \"\",\n \"\"\n ],\n \"bay_id\": \"\",\n \"expires_at\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/collections"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"2327a28c-f03e-4768-83bb-866f5d016ffe"},{"name":"Retrieve a List of Collectable Assets","id":"a1e24e7a-687d-41c5-99bd-d3413796805b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/collections/collectables?filter[installation_id]=","urlObject":{"path":["collections","collectables"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"description":{"content":"

Filter the collectables by installation ID

\n","type":"text/plain"},"key":"filter[installation_id]","value":""}],"variable":[]}},"response":[{"id":"9fdd9662-dcb5-43c7-933e-8de6c00af02f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/collections/collectables?filter[installation_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["collections","collectables"],"query":[{"description":"Filter the collectables by installation ID","key":"filter[installation_id]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"collectables\": [\n {\n \"bay_id\": \"\",\n \"collectable_description\": \"\",\n \"asset_id\": \"\",\n \"asset_type_id\": \"\",\n \"asset_description\": \"\"\n },\n {\n \"bay_id\": \"\",\n \"collectable_description\": \"\",\n \"asset_id\": \"\",\n \"asset_type_id\": \"\",\n \"asset_description\": \"\"\n }\n ]\n}"}],"_postman_id":"a1e24e7a-687d-41c5-99bd-d3413796805b"}],"id":"03255aa5-deec-41dc-a68d-5659d6358875","_postman_id":"03255aa5-deec-41dc-a68d-5659d6358875","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Swaps","item":[{"name":"Individual Swap","item":[{"name":"Retrieve a Swap","id":"57f7b8af-34ae-4035-aa9e-8f774cfd58d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/swaps/:id","description":"

Get a swap

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["swaps",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"8054d3df-6255-4497-be12-21cd1979cb1a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ba3e73c5-5976-43c1-8fbd-de58a7dd1dff","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"swap\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Collected\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\"\n }\n}"},{"id":"02bce4f1-cadb-49d5-9b43-f45679635ec5","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"bc69d107-6668-4cbd-9b49-506643575bdc","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"57f7b8af-34ae-4035-aa9e-8f774cfd58d3"},{"name":"Cancel a Swap","id":"6087f651-ec9e-4171-87c7-d2dbb3e2db9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/swaps/:id/cancel","description":"

Cancel a pending collection

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the swap to be cancelled
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["swaps",":id","cancel"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"65094a96-305e-4f79-832b-d52d86d8115c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e3402d12-61f8-47c4-a384-dddb1c83550b","name":"No Content","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","cancel"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"1a68b8dd-73d1-4179-b299-cb3023b9d327","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"fc92a25c-4914-42f3-aa36-c08cd2117481","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b4e6a5b8-f978-4da2-8696-126bd191f9ad","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"cff2356f-fa9a-4278-a8c1-28165ad9dbbd","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","cancel"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"6087f651-ec9e-4171-87c7-d2dbb3e2db9d"},{"name":"Get Code for a Swap","id":"bd7bb60b-0bc9-470c-91d6-e0a017376aa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/swaps/:id/code","description":"

Get the code for a swap

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["swaps",":id","code"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"53a1922b-e7f5-4610-a022-01f8d34df576","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2859ba06-1145-40ad-8a2e-8dbc857d907f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","code"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"},{"id":"6312987b-1693-4e3a-aeb5-19fc93fcf62e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","code"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"125e6ab7-c857-46d6-9316-dba94765c64a","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","code"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"52026962-b4c3-4479-8374-c65d1b1d308e","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","code"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"bd7bb60b-0bc9-470c-91d6-e0a017376aa5"},{"name":"Complete a Swap","id":"c57460bc-5e2b-44a8-9856-7aaad118a38b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"swapped_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps/:id/complete","description":"

This endpoint will mark a pending swap as completed.

\n

This should be used for testing purposes when using real lockers is not practical

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the swap to be completed
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
swapped_atdateYesThe date that the swap was completed at
transaction_idstringYesThe unique UUID of the swap transaction
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["swaps",":id","complete"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"16f32aa0-d5bd-4b96-8637-dbc241ca0463","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"swapped_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","complete"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"swap\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Collected\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\"\n }\n}"},{"id":"be06c46d-f87a-4e00-8985-716e9cb80f57","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"swapped_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","complete"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9e5a8e73-fcd0-43f5-93ca-9a25a4631570","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"swapped_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","complete"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2cc03708-3649-43fa-bc4e-dfb7db29e8b0","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"swapped_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","complete"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"11a30ce9-acc7-48d5-be4b-f640ed72474c","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"swapped_at\": \"\",\n \"transaction_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/swaps/:id/complete","host":["https://{{domain}}.onarken.com/api/v1"],"path":["swaps",":id","complete"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"c57460bc-5e2b-44a8-9856-7aaad118a38b"}],"id":"4972eb5d-2024-4500-8ded-ae14a93872a0","_postman_id":"4972eb5d-2024-4500-8ded-ae14a93872a0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Swaps","id":"ad06ef11-d03d-4643-971f-7ba437457969","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/swaps","description":"

Get a list of swaps

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["swaps"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"01b982f1-32b6-4609-82b2-3616d1667770","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"swaps\": [\n {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Collected\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\"\n },\n {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Collected\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"df8af658-3665-42c6-afb8-5112e756fec1","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"ad06ef11-d03d-4643-971f-7ba437457969"},{"name":"Arrange a Swap","id":"37cc545d-1a22-4d07-ba17-1d0dabda163f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bay_id\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\",\n \"reason_id\": \"\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps","description":"

Create a Swap

\n

This endpoint allows you to create a new Swap in ONARKEN.

\n

Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
bay_idstringYesThe ID of the bay where this swap is to take place
swapping_asset_idstringNoThe ID of the asset that is being swapped
swapping_asset_descriptionstringNoThe description of the asset that is being swapped
user_idstring/intNoThe user id for the swap
expires_atdate/timeNoThe date/time that the swap is due to automatically expire
transition_asset_to_statusstring/intNoDEPRECATED

Please use Reason ID
reason_idstringNoThe UUID of a reason in ONARKEN for this Swap
extension_attributesarrayNoArray of keys and values of extension attributes and their assigned values.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["swaps"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c2542fcd-bbad-4d2c-8ce6-7e4b03256bad","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"bay_id\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\",\n \"extension_attributes\": {\n \"key\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"swap\": {\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Collected\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\"\n }\n}"},{"id":"4cf87cef-c65b-4fa9-925c-3e7dd39e243f","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"da3ac63a-cead-4df1-8c52-fd6e6ea681cf","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"227b4224-4df7-451f-a07d-04815468c9d9","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b27ed497-4330-4bd6-a82d-09790c749768","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"creator_id\": \"\",\n \"bay_id\": \"\",\n \"status\": \"Waiting\",\n \"collecting_asset_id\": \"\",\n \"collecting_asset_description\": \"\",\n \"swapping_asset_id\": \"\",\n \"swapping_asset_description\": \"\",\n \"user_id\": \"\",\n \"expires_at\": \"\",\n \"swapped_at\": \"\",\n \"transition_asset_to_status\": \"Deployable\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/swaps"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"37cc545d-1a22-4d07-ba17-1d0dabda163f"}],"id":"09e2ebf5-8af9-4e21-a96b-4fc231d55503","_postman_id":"09e2ebf5-8af9-4e21-a96b-4fc231d55503","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Stacks","item":[{"name":"Individual Stack","item":[{"name":"Get a Stack","id":"76996306-64b1-41f0-9e55-d2f0dd29e232","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/stacks/:id","urlObject":{"path":["stacks",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"2f9b4111-ba03-4495-81f0-bd25a9091248","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5521267f-55b2-4660-b3fd-8760536d3ccb","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/stacks/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["stacks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"stack\": {\n \"id\": \"\",\n \"installation_id\": \"\",\n \"item_count\": {\n \"completed\": \"\",\n \"outstanding\": \"\",\n \"total\": \"\"\n },\n \"is_flexible\": false\n }\n}"}],"_postman_id":"76996306-64b1-41f0-9e55-d2f0dd29e232"},{"name":"Cancel a Stack Along With All Items","id":"fc3bdf10-00cd-4bdb-99f4-014c506ae18f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{domain}}.onarken.com/api/v1/stacks/:id","description":"

Cancel a stack along with all items

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the stack to be cancelled
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the stack to cancel

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"903182e0-bf4b-4934-825b-83c17a41878c","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/stacks"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fc3bdf10-00cd-4bdb-99f4-014c506ae18f"},{"name":"Retrieve a List of all Stack Items","id":"baf4f04f-a20e-45dd-9a62-e7de499571ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/stacks/:uuid/items","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks",":uuid","items"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"e0548c51-c4b1-433f-8a81-fe2ba83e8515","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"dfc579fe-6944-43f6-9994-216064a01f91","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/stacks/:uuid/items","host":["https://{{domain}}.onarken.com/api/v1"],"path":["stacks",":uuid","items"],"variable":[{"key":"uuid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"stack_items\": [\n {\n \"id\": \"\",\n \"order\": \"\",\n \"completed\": \"\",\n \"type\": \"collection\",\n \"stackable\": {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"collected_at\": \"\",\n \"expires_at\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"order\": \"\",\n \"completed\": \"\",\n \"type\": \"collection\",\n \"stackable\": {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"collected_at\": \"\",\n \"expires_at\": \"\"\n }\n }\n ]\n}"}],"_postman_id":"baf4f04f-a20e-45dd-9a62-e7de499571ac"},{"name":"Create a Collection for Stack","id":"63e09617-600c-459f-ae41-edf096b8eb1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bay_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/stacks/:uuid/collections","description":"

Create a collection for an existing stack

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the stack to arrange a collection for
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
bay_idstringYesThe unique UUID of the bay for the collection
expires_atdateNoAn automatic expiry date for the collection
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks",":uuid","collections"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the stack to add a collection to

\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[{"id":"4f0fefa3-bee6-43f5-8270-7a65572f0701","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"bay_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/stacks/:uuid/collections","host":["https://{{domain}}.onarken.com/api/v1"],"path":["stacks",":uuid","collections"],"variable":[{"key":"uuid"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"collection\": {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"collected_at\": \"\",\n \"expires_at\": \"\"\n }\n}"}],"_postman_id":"63e09617-600c-459f-ae41-edf096b8eb1c"},{"name":"Create a Drop Off for Stack","id":"da699f59-003e-4660-b4fa-6fef5af63a62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/stacks/:id/drop_offs","description":"

Create a Drop Off for an existing Stack

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the stack to create a drop off for
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
asset_idstringNoThe unique UUID of the asset to drop off - Required if no asset_description is provided
transition_asset_to_statusstring
EndOfLIfe
Deployable
Service		NoThe state of the asset that is being dropped of
asset_descriptionstringNoA description of the asset being dropped off - Required if no asset_id is provided
with_collection_forarrayNoAn array of users unique UUID's that can collect the asset being dropped off
expires_atdateNoAn automatic expiry date for the drop off
bay_requirementsarrayNoAn array of bay requirements that specifies the charging_type, minimum_size, connectivity_type
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks",":id","drop_offs"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the stack

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fe60a6bb-ab14-4d5e-b6db-f5e5b5368e13","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"EndOfLife\",\n \"asset_description\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Large\",\n \"connectivity_equipment\": \"KVM\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/stacks/:uuid/drop_offs","host":["https://{{domain}}.onarken.com/api/v1"],"path":["stacks",":uuid","drop_offs"],"variable":[{"key":"uuid"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"drop_off\": {\n \"id\": \"\",\n \"bay_id\": \"\",\n \"asset_id\": \"\",\n \"transition_asset_to_status\": \"Service\",\n \"asset_description\": \"\",\n \"notes\": \"\",\n \"dropped_off_at\": \"\",\n \"with_collection_for\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"bay_requirements\": {\n \"minimum_size\": \"Medium\",\n \"charging_type\": \"SmartLine\",\n \"connectivity_equipment\": \"KVM\"\n }\n }\n}"}],"_postman_id":"da699f59-003e-4660-b4fa-6fef5af63a62"},{"name":"Retrieve the One Time Code for Stack","id":"3eaa99b6-9b35-4394-8be0-4225cef754b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/stacks/:id/code","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks",":id","code"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d0e85f04-49f6-4f7b-be6d-62f56dbf78fb","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/stack/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["stack",":id","code"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"}],"_postman_id":"3eaa99b6-9b35-4394-8be0-4225cef754b2"}],"id":"f8427294-56e1-4017-bbbf-6abb072183ab","_postman_id":"f8427294-56e1-4017-bbbf-6abb072183ab","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a list of stacks","id":"f2a54bfe-53fd-463b-9539-c7ffad8408ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/stacks","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

Include stacks that have already been completed

\n","type":"text/plain"},"key":"filter[include_completed]","value":""},{"disabled":true,"description":{"content":"

Filter stacks by installation id

\n","type":"text/plain"},"key":"filter[installation_id]","value":""}],"variable":[]}},"response":[{"id":"d217a18e-6108-45b9-93d5-35cc364887cd","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/stacks?filter[include_completed]=&filter[installation_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["stacks"],"query":[{"description":"Include stacks that have already been completed","key":"filter[include_completed]","value":""},{"description":"Filter stacks by installation id","key":"filter[installation_id]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"stacks\": [\n {\n \"id\": \"\",\n \"installation_id\": \"\",\n \"item_count\": {\n \"completed\": \"\",\n \"outstanding\": \"\",\n \"total\": \"\"\n },\n \"is_flexible\": false\n },\n {\n \"id\": \"\",\n \"installation_id\": \"\",\n \"item_count\": {\n \"completed\": \"\",\n \"outstanding\": \"\",\n \"total\": \"\"\n },\n \"is_flexible\": false\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"}],"_postman_id":"f2a54bfe-53fd-463b-9539-c7ffad8408ca"},{"name":"Create a Stack","id":"c2f47cb6-e140-4e74-9db7-d37f8668205f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"installation_id\": \"\",\n \"extension_attributes\": [\n \"\",\n \"\"\n ],\n \"is_flexible\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/stacks","description":"

Create a new stack

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
installation_idstringYesThe unique UUID of the installation that the stack is arranged for
extension_attributesarrayNoAn array of extension attributes to be added to the stack
is_flexibleboolYesTrue or False, as to if the stack is in a required order or a flexible order
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stacks"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"887cf183-9c54-4a9b-be8e-612bed26026e","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"installation_id\": \"\",\n \"item_count\": {\n \"completed\": \"\",\n \"outstanding\": \"\",\n \"total\": \"\"\n },\n \"is_flexible\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/stacks"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"stack\": {\n \"id\": \"\",\n \"installation_id\": \"\",\n \"item_count\": {\n \"completed\": \"\",\n \"outstanding\": \"\",\n \"total\": \"\"\n },\n \"is_flexible\": false\n }\n}"}],"_postman_id":"c2f47cb6-e140-4e74-9db7-d37f8668205f"}],"id":"0bac1bf9-1f04-411c-811b-8533def79b85","_postman_id":"0bac1bf9-1f04-411c-811b-8533def79b85","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Reasons","item":[{"name":"Retrieve a List of Reasons","id":"76f1830f-7b6a-4caa-bee9-079cfc0d7948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/reasons","description":"

Get a list of Reasons

\n

This endpoint retreives a list of drop drop off reasons.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["reasons"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"901bb3d1-8663-43b5-bfcb-3f887bd5d551","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"reasons\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n }\n ]\n}"},{"id":"d98ec437-d541-4cee-bd0b-f87070f60039","name":"Unauthorised","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c9c85719-9055-4639-8711-39110bd93fd3","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ca08c254-ca96-43ee-b554-42d048bd7da4","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"76f1830f-7b6a-4caa-bee9-079cfc0d7948"},{"name":"Create a Reason","id":"03b4dbf0-dc4e-41f4-8a48-ad0c9337330c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/reasons","description":"

Create a Reason

\n

This endpoint allows you to create a new Reason.

\n

Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesThe reason name must be a string, be atleast 4 characters long and no longer than 64. The reason name must also be unique in ONARKEN.
locker_display_namestringYesThe locker_display_name must be a string, be atleast 3 characters long and no longer than 22 charcaters.
colourstringYesThe colour must be a string and must be available inside of ONARKEN. (Blue, Red, Slate, Orange, Yellow, Green, Teal, Indigo, Purple, Pink)
asset_statestring
one of
- EndOfLife
- Deployable
- Service		NullableWill transition a known asset to this status after completion
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["reasons"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f5f7717f-043a-498a-b87c-58b54130fd86","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }\n\n{\n \"name\": \"Name\",\n \"locker_display_name\": \"Apples\",\n \"colour\": \"blue\",\n \"asset_state\": \"96\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n }\n ]\n}"},{"id":"f7646ee3-8063-4ca8-97e4-ff5853c3eb19","name":"Unauthorised","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }\n\n{\n \"name\": \"Name\",\n \"locker_display_name\": \"Apples\",\n \"colour\": \"blue\",\n \"asset_state\": \"96\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"af879239-0666-44ac-86a9-45606b250b57","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }\n\n{\n \"name\": \"Name\",\n \"locker_display_name\": \"Apples\",\n \"colour\": \"blue\",\n \"asset_state\": \"96\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9b7fd968-fc52-4724-b984-c1488f823704","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }\n\n{\n \"name\": \"Name\",\n \"locker_display_name\": \"Apples\",\n \"colour\": \"blue\",\n \"asset_state\": \"96\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/reasons"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"03b4dbf0-dc4e-41f4-8a48-ad0c9337330c"},{"name":"Get a single Reason","id":"ad8b1cf4-a04f-4037-9161-1b3b6e5137b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }"},"url":"https://{{domain}}.onarken.com/api/v1/reasons/:id","description":"

Get a single Reason

\n

This endpoint retrieves a single reason, by suppyling the required reasons ID

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the reason that you are trying to receive from ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["reasons",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"697f338c-03ab-428f-b165-4fd1366a54d1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": {\n \"id\": \"\",\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n }\n}"},{"id":"e6bb30ad-dd61-48f9-a7da-6d79e3491c97","name":"Unauthorised","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"48429880-f45e-4fa4-91a9-df7d52f3acdc","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"cc6e6e82-cb5d-433f-911c-4cc1bc1ffc38","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"// {\n// \"name\": \"\",\n// \"locker_display_name\": \"\",\n// \"colour\": \"\",\n// \"asset_state\": \"\"\n// }"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"ad8b1cf4-a04f-4037-9161-1b3b6e5137b8"},{"name":"Update a Reason","id":"01356593-59c0-4101-b11d-d7e5e1547a21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/reasons/:id","description":"

Update an existing Reason

\n

This endpoint allows you to update an existing reason inside of ONARKEN.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe ID of the reason required to be updated inside of ONARKEN.
\n

Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesThe reason name must be a string, be atleast 4 characters long and no longer than 64. The reason name must also be unique in ONARKEN.
locker_display_namestringYesThe locker_display_name must be a string, be atleast 3 characters long and no longer than 22 charcaters.
colourstringYesThe colour must be a string and must be available inside of ONARKEN. (Blue, Red, Slate, Orange, Yellow, Green, Teal, Indigo, Purple, Pink)
asset_statestring
one of
- EndOfLife
- Deployable
- Service		NullableWill transition a known asset to this status after completion
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["reasons",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the reason

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"595ade0a-8a06-48c2-b2c3-c77541042c36","name":"OK","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": {\n \"id\": \"\",\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n }\n}"},{"id":"3e1fcb0a-97e8-4a81-9b59-0f86fbd8d604","name":"Unauthorised","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"95869ac8-6097-431e-b8ff-f1ac31f379b3","name":"Not Found","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n} "},{"id":"984d45f7-dede-479b-bc1b-bd5710770a9f","name":"Forbidden","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"locker_display_name\": \"\",\n \"colour\": \"\",\n \"asset_state\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"01356593-59c0-4101-b11d-d7e5e1547a21"},{"name":"Delete a Reason","id":"bcc29206-cf42-4cc7-bf24-ef4f5558fe7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/reasons/:id","description":"

Delete a single Reason

\n

This endpoint allows you to delete an existing reason inside of ONARKEN.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe UUID of the reason required to be deleted inside of ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["reasons",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the reason

\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"8b904d94-727c-4790-a0b1-b3ddb341aabb","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":"string","description":"The ID of the reason to be deleted inside of ONARKEN."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"88c8f2a3-3a5d-4593-87ed-21c86b0eb647","name":"Unauthorised","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":"string","description":"The ID of the reason to be deleted inside of ONARKEN."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"49bd721c-0fe3-4b8f-a910-378eb8e996dd","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":"string","description":"The ID of the reason to be deleted inside of ONARKEN."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b883f400-747c-4f15-87ab-c533cafc8def","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/reasons/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["reasons",":id"],"variable":[{"key":"id","value":"string","description":"The ID of the reason to be deleted inside of ONARKEN."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"bcc29206-cf42-4cc7-bf24-ef4f5558fe7f"}],"id":"d70e399f-b03b-4b81-a46f-389785d8962f","_postman_id":"d70e399f-b03b-4b81-a46f-389785d8962f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}}],"id":"99cf5b78-602d-4051-98cb-68a0f8c0b2b4","description":"

All requests in this section pertain specifically to the Drop Off & Collection service.

\n

Only Smart Locker bays that are explicitly configured for Drop Off & Collection are eligible for use with this service.

\n","_postman_id":"99cf5b78-602d-4051-98cb-68a0f8c0b2b4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Smart Locker Management","item":[{"name":"Installations","item":[{"name":"Individual Installation","item":[{"name":"Languages","item":[{"name":"Retrieve a List of Languages for Installation","id":"c7133795-7acb-4c14-b9f7-fa3d40dced9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","description":"

List languages assigned to an installation

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id","languages"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"63ab7a04-bb1e-4071-81e8-c417cbd040f9","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f267b317-d73c-475d-8b52-d4fd07ad4c78","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"languages\": [\n {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n },\n {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n }\n ]\n}"},{"id":"5c501c2a-06e9-4389-9e7f-a7784e5dec31","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"dfad8805-ddda-4fca-9de8-2a60e76c2b62","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"c7133795-7acb-4c14-b9f7-fa3d40dced9f"},{"name":"Add Languages to Installation","id":"f1ba3b50-9410-4b1e-8bf5-656c7333cc93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","description":"

Add a language to an installation

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the installation
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
languagesarrayYesAn array of language unique UUID's to be added to the installation
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id","languages"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the installation

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b08495f3-1eaa-4ca1-8e70-cad166f70ce5","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"languages\": [\n {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n },\n {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n }\n ]\n}"},{"id":"e4e27160-2e9f-465d-8ee8-84df671cda8d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b901a9a4-7b1c-4d86-8df0-7c218aa0bc9c","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"10d9459e-6ca1-4889-a1e1-3fc702e99c74","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f7570bbd-7ce5-485b-bd11-e46d3fa6d979","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"f1ba3b50-9410-4b1e-8bf5-656c7333cc93"},{"name":"Remove Languages from Installation","id":"8f9d7f60-b60d-4798-84d0-12b5380ae6f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","description":"

Remove languages from an installation

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the installation
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
languagesarrayYesAn array of language unique UUID's to be removed from the installation
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id","languages"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the installation

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"302a5327-e96f-4d9d-b20d-679a1241e358","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"languages\": [\n {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n },\n {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n }\n ]\n}"},{"id":"aae786ca-ac2b-49a7-9103-4b026ae51eb5","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"1e6beb61-b54e-4fd5-a258-09799c3d823c","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"699fea27-2c69-4a47-ac99-839cb87ff06c","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"3a2862ef-3ef7-4fef-a9e1-407deb726b19","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"languages\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"8f9d7f60-b60d-4798-84d0-12b5380ae6f9"},{"name":"Make a Language the Default for Installation","id":"6b45f5a4-a450-4c64-9ea3-97c5aa464186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","description":"

Change the installation default language

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the installation
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
languagestringYesThe unique UUID of the language to make default on the installation
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id","languages","default"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the installation

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"96418f56-dae8-48c1-9d23-cb9cb2db8f5b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages","default"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n}"},{"id":"b09bc791-e664-4844-b92d-d29276853a42","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages","default"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"862f2e11-008f-4144-801a-f53a21d34e57","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages","default"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a4296e9d-e76b-44c9-80ec-b6e5821e5893","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages","default"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7939c3fc-2b06-46f0-a179-b0d64729b47d","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"language\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages","default"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"6b45f5a4-a450-4c64-9ea3-97c5aa464186"},{"name":"Get the Default Language for Installation","id":"9d189195-9975-4e70-96ef-d2e2e1fc4b82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","description":"

Get an installations default language

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id","languages","default"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"4ea25f24-2c2a-4005-a840-0b5409523fbd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cf827f44-e19e-43d2-b92f-13801f378be4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id/languages/default","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id","languages","default"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"language\": {\n \"default\": false,\n \"id\": \"\",\n \"image\": \"\",\n \"name\": \"\"\n }\n}"}],"_postman_id":"9d189195-9975-4e70-96ef-d2e2e1fc4b82"}],"id":"3aca3adb-e6da-4cc6-b43d-fa55e5bee577","_postman_id":"3aca3adb-e6da-4cc6-b43d-fa55e5bee577","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a Single Installation","id":"06f1b51a-df28-405a-acab-3259e4454530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/installations/:id","description":"

Get an installation

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"66e2607b-43eb-45bd-8a5e-3050fda4e136","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6c423582-366a-4364-8166-5d76d3d7caf2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installation\": {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Diplomat\",\n \"secondary_authentication\": \"Pin\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"FullKeyboard\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n}"},{"id":"9ccb1943-15e6-4360-99b7-e79546cd8a97","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7781f53b-94ce-445e-9a1f-fe10fe8bc925","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"06f1b51a-df28-405a-acab-3259e4454530"},{"name":"Patch Installation","id":"ee5b229b-bb9e-4f71-a180-9a47f5520b4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"terms_and_conditions_id\": \"\",\n \"screen_design_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/installations/:id","description":"

Use this endpoint to configure settings on your Installation

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9cb3a7ef-b314-4d5f-815d-6b54668d935b","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"terms_and_conditions_id\": \"\",\n \"screen_design_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installation\": {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Diplomat\",\n \"secondary_authentication\": \"Pin\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"FullKeyboard\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n}"},{"id":"cbba688f-f139-44de-bbc5-9653aff5f6e3","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"terms_and_conditions_id\": \"\",\n \"screen_design_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6e4cc3ee-e62b-4a80-8bba-4bb16602da05","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"terms_and_conditions_id\": \"\",\n \"screen_design_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a56c5060-0e3d-473e-99b2-519ef5a0a655","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"terms_and_conditions_id\": \"\",\n \"screen_design_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c30b8a05-e7bc-4c65-9260-79937f7757f2","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"terms_and_conditions_id\": \"\",\n \"screen_design_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/installations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["installations",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"ee5b229b-bb9e-4f71-a180-9a47f5520b4c"}],"id":"7853025e-2e2c-4761-8ea2-214041f12f07","_postman_id":"7853025e-2e2c-4761-8ea2-214041f12f07","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Installations","id":"b2606ab5-bf19-40e2-bab1-f92da6b1dde4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/installations","description":"

Get a list of installations

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["installations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cf2fd40a-dc5e-4398-9b28-b05e0eea4cfb","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/installations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Diplomat\",\n \"secondary_authentication\": \"None\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"FullKeyboard\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Diplomat\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"FullKeyboard\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"8c38fc67-ad0a-49c7-ae44-8d3b4593ea21","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/installations"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b2606ab5-bf19-40e2-bab1-f92da6b1dde4"}],"id":"fd2fc5da-85ab-4678-9310-6ed69e6e8c1f","_postman_id":"fd2fc5da-85ab-4678-9310-6ed69e6e8c1f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Bays","item":[{"name":"Individual Bay","item":[{"name":"Asset","item":[{"name":"Retrieve an Asset that is in or belongs to a bay","id":"373771b9-f75c-4b32-9e70-dd6bb628a7c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","description":"

Get an asset within a bay

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id","asset"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"9790a8fd-4b84-4b55-9b79-37eac7793de2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2f208f40-30d7-40d2-8982-90a318c854c3","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset\": {\n \"id\": \"pMLLN_M/u\",\n \"asset_type_id\": \"\",\n \"charge_level\": \"PartiallyCharged\",\n \"status\": \"Unknown\",\n \"bay_id\": \"\",\n \"installation_id\": \"\",\n \"location_id\": \"\"\n }\n}"},{"id":"add51d3f-4f3d-469a-aee9-badb39deb91b","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"dc00e680-50c0-4009-89ed-ab1fa98d387d","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ab051f0c-81b6-4cf8-b018-d336979bfda8","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"9cbbc369-bc90-4c0e-b5f9-2847aeb7a402","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"373771b9-f75c-4b32-9e70-dd6bb628a7c6"},{"name":"Load an Asset into a Bay","id":"936fcaf5-175a-4b57-bcb6-d5497f76435c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","description":"

Load an asset into a bay

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id","asset"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"a4eb9062-7633-4057-8175-7028da1d5f42","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0bfccc6e-caf6-4194-9b2f-1c6a55cb12e9","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset\": {\n \"id\": \"pMLLN_M/u\",\n \"asset_type_id\": \"\",\n \"charge_level\": \"PartiallyCharged\",\n \"status\": \"Unknown\",\n \"bay_id\": \"\",\n \"installation_id\": \"\",\n \"location_id\": \"\"\n }\n}"},{"id":"fbd2ef26-dad6-4333-8672-d1bad4617f57","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6be5e901-5055-498a-91e0-735b26074989","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"45d76d7f-d164-49bc-9a2d-a9b11c0e0a63","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0044480d-2a6d-4025-9702-e96180162c93","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"936fcaf5-175a-4b57-bcb6-d5497f76435c"},{"name":"Unload an Asset from a Bay","id":"ed46401f-050a-47f5-96bd-b65ca1cdeb70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","description":"

Unload an asset from a bay

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the bay to unload the asset from
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id","asset"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the bay

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7af668e7-8015-4737-bca5-e9891b39e222","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"37dbcdda-9059-434e-a757-6bede94830e6","name":"Bad Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"730dc738-1cb5-4b3c-a545-f5cf92e7428c","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f9368e84-cbd9-43c6-b080-0e55ee83d789","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"3d374781-e26e-4eb9-b359-abe2d28307ae","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/asset","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","asset"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"ed46401f-050a-47f5-96bd-b65ca1cdeb70"}],"id":"4ca02a07-abe8-4ff1-a678-8ce8c4d7f935","_postman_id":"4ca02a07-abe8-4ff1-a678-8ce8c4d7f935","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a Single Bay","id":"eee699bd-1334-40ac-befe-01505d9f9423","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bays/:id","description":"

Get a bay

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"3a8459f3-9568-4c09-8d6c-3c2f1dfa232e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ac7291d1-27f7-414e-9856-118c44697ee1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"bay\": {\n \"id\": \"\",\n \"bay_number\": \"\",\n \"installation_id\": \"\",\n \"easy_access\": false,\n \"status\": \"Fault\",\n \"size\": \"Large\",\n \"charging_type\": \"BaseLine\",\n \"smartline_profile\": \"\",\n \"connectivity_equipment\": \"None\",\n \"door_status\": {\n \"is_open\": false,\n \"opened_at\": \"\"\n },\n \"service\": \"DropOffCollectionLocker\"\n }\n}"},{"id":"63e6d217-40e8-413a-80ff-ee907a716ebd","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"632000bb-02af-426e-95bd-6e46d8f674c9","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"eee699bd-1334-40ac-befe-01505d9f9423"},{"name":"Patch a Bay","id":"ad8643e5-ebf1-4582-93d1-f45ca396c2b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"easy_access\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/bays/:id","description":"

Update a bays access settings

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the bay to update
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
easy_accessboolYesA true or false value to update the bay's easy access settings
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the bay

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e0735bfd-4078-4cc2-976a-44223f2e1a8e","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"easy_access\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/bays/:id","path":["bays",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"bay\": {\n \"id\": \"\",\n \"bay_number\": \"\",\n \"installation_id\": \"\",\n \"easy_access\": false,\n \"status\": \"Fault\",\n \"size\": \"Large\",\n \"charging_type\": \"BaseLine\",\n \"smartline_profile\": \"\",\n \"connectivity_equipment\": \"None\",\n \"door_status\": {\n \"is_open\": false,\n \"opened_at\": \"\"\n },\n \"service\": \"DropOffCollectionLocker\"\n }\n}"}],"_postman_id":"ad8643e5-ebf1-4582-93d1-f45ca396c2b2"},{"name":"Mark a Bay as Out of Service","id":"e2831280-d78a-4423-8e78-b9ab74110ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bays/:id/disable","description":"

Disable a bay

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the bay to be disabled
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id","disable"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the bay

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0c56daaa-eded-48b0-8da0-1309b9d37924","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/disable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","disable"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"bay\": {\n \"id\": \"\",\n \"bay_number\": \"\",\n \"installation_id\": \"\",\n \"easy_access\": false,\n \"status\": \"Fault\",\n \"size\": \"Large\",\n \"charging_type\": \"BaseLine\",\n \"smartline_profile\": \"\",\n \"connectivity_equipment\": \"None\",\n \"door_status\": {\n \"is_open\": false,\n \"opened_at\": \"\"\n },\n \"service\": \"DropOffCollectionLocker\"\n }\n}"},{"id":"252c74c1-7d80-4323-bfd9-72bc87bcc5d3","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/disable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","disable"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"d96daf35-0a30-4a78-8c69-9a78d0b9fb29","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/disable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","disable"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"327d8807-cd7f-4356-8662-8967596038b5","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/disable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","disable"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"e2831280-d78a-4423-8e78-b9ab74110ac9"},{"name":"Put a Bay Back into Service","id":"457bcf88-ff09-4ff3-b0a8-922069b7d0c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bays/:id/enable","description":"

Enable a disabled bay

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the bay to enable
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays",":id","enable"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the bay

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8ae3d753-437d-4cf7-b87d-0db7772df416","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/enable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","enable"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"bay\": {\n \"id\": \"\",\n \"bay_number\": \"\",\n \"installation_id\": \"\",\n \"easy_access\": false,\n \"status\": \"Fault\",\n \"size\": \"Large\",\n \"charging_type\": \"BaseLine\",\n \"smartline_profile\": \"\",\n \"connectivity_equipment\": \"None\",\n \"door_status\": {\n \"is_open\": false,\n \"opened_at\": \"\"\n },\n \"service\": \"DropOffCollectionLocker\"\n }\n}"},{"id":"22aea3f8-0f2c-41d3-b9d5-9262ad59d6b2","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/enable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","enable"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8c34235e-1dd6-44f8-8a16-b8e47b0ed9e4","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/enable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","enable"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"93939811-677f-474d-aa64-ec20e31fe229","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays/:id/enable","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays",":id","enable"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"457bcf88-ff09-4ff3-b0a8-922069b7d0c4"}],"id":"e87d623a-d231-42a2-9e92-c35a9e50c379","_postman_id":"e87d623a-d231-42a2-9e92-c35a9e50c379","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Bays","id":"7df38301-3364-4175-8fd7-0db2e186f742","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/bays","description":"

Retrieve a paginated list of bays from all installations.

\n

Available Services

\n
    \n

  • LoanLocker

    \n
    • \n

  • DropOffCollectionLocker

    \n
    • \n

  • HotLocker

    \n
    • \n
\n

Available Charging Types

\n
    \n

  • BaseLine

    \n
    • \n

  • ChargeLine

    \n
    • \n

  • SmartLine

    \n
    • \n
\n

Available Connectivity Types

\n
    \n

  • None

    \n
    • \n

  • DataTransfer

    \n
    • \n

  • KVM

    \n
    • \n
\n

Available Sizes

\n
    \n

  • ExtraSmall

    \n
    • \n

  • Small

    \n
    • \n

  • Medium

    \n
    • \n

  • Large

    \n
    • \n

  • ExtraLarge

    \n
    • \n

  • ExtraExtraLarge

    \n
    • \n
\n

Available Statuses

\n
    \n

  • Vacant

    \n
    • \n

  • Ok

    \n
    • \n

  • InUse

    \n
    • \n

  • Reserved

    \n
    • \n

  • Booked

    \n
    • \n

  • PendingLoan

    \n
    • \n

  • PendingDropOff

    \n
    • \n

  • PendingCollection

    \n
    • \n

  • Occupied

    \n
    • \n

  • Assigned

    \n
    • \n

  • OutOfService

    \n
    • \n

  • Fault

    \n
    • \n

  • Alert

    \n
    • \n

  • Quarantined

    \n
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["bays"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

Change the page

\n","type":"text/plain"},"key":"page[number]","value":"1"},{"disabled":true,"description":{"content":"

How many results per page

\n","type":"text/plain"},"key":"page[size]","value":"30"},{"disabled":true,"description":{"content":"

The UUID of a Installation

\n","type":"text/plain"},"key":"filter[installation_id]","value":""},{"disabled":true,"description":{"content":"

The service that the bay provides

\n","type":"text/plain"},"key":"filter[service]","value":"HotLocker"},{"disabled":true,"key":"filter[charging_type]","value":"BaseLine"},{"disabled":true,"key":"filter[connectivity_equipment]","value":"KVM"},{"disabled":true,"key":"filter[size]","value":"ExtraSmall"},{"disabled":true,"description":{"content":"

Status of the Bay

\n","type":"text/plain"},"key":"filter[status]","value":"Quarantined"},{"disabled":true,"key":"filter[easy_access]","value":""}],"variable":[]}},"response":[{"id":"21ebaa05-3d41-4160-b877-5556cc58cd52","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays?page[number]=1&page[size]=30&filter[installation_id]=&filter[service]=HotLocker&filter[charging_type]=BaseLine&filter[connectivity_equipment]=KVM&filter[size]=ExtraSmall&filter[status]=Quarantined&filter[easy_access]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays"],"query":[{"description":"Change the page","key":"page[number]","value":"1"},{"description":"How many results per page","key":"page[size]","value":"30"},{"description":"The UUID of a Installation","key":"filter[installation_id]","value":""},{"description":"The service that the bay provides","key":"filter[service]","value":"HotLocker"},{"key":"filter[charging_type]","value":"BaseLine"},{"key":"filter[connectivity_equipment]","value":"KVM"},{"key":"filter[size]","value":"ExtraSmall"},{"description":"Status of the Bay","key":"filter[status]","value":"Quarantined"},{"key":"filter[easy_access]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"bays\": [\n {\n \"id\": \"\",\n \"bay_number\": \"\",\n \"installation_id\": \"\",\n \"easy_access\": false,\n \"status\": \"InUse\",\n \"size\": \"Medium\",\n \"charging_type\": \"BaseLine\",\n \"smartline_profile\": \"\",\n \"connectivity_equipment\": \"DataTransfer\",\n \"door_status\": {\n \"is_open\": false,\n \"opened_at\": \"\"\n },\n \"service\": \"HotLocker\"\n },\n {\n \"id\": \"\",\n \"bay_number\": \"\",\n \"installation_id\": \"\",\n \"easy_access\": false,\n \"status\": \"InUse\",\n \"size\": \"Small\",\n \"charging_type\": \"BaseLine\",\n \"smartline_profile\": \"\",\n \"connectivity_equipment\": \"DataTransfer\",\n \"door_status\": {\n \"is_open\": false,\n \"opened_at\": \"\"\n },\n \"service\": \"DropOffCollectionLocker\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"c28380af-8a88-44b9-9045-831872045b7f","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays?page[number]=1&page[size]=30&filter[installation_id]=&filter[service]=HotLocker&filter[charging_type]=BaseLine&filter[connectivity_equipment]=KVM&filter[size]=ExtraSmall&filter[status]=Quarantined&filter[easy_access]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays"],"query":[{"description":"Change the page","key":"page[number]","value":"1"},{"description":"How many results per page","key":"page[size]","value":"30"},{"description":"The UUID of a Installation","key":"filter[installation_id]","value":""},{"description":"The service that the bay provides","key":"filter[service]","value":"HotLocker"},{"key":"filter[charging_type]","value":"BaseLine"},{"key":"filter[connectivity_equipment]","value":"KVM"},{"key":"filter[size]","value":"ExtraSmall"},{"description":"Status of the Bay","key":"filter[status]","value":"Quarantined"},{"key":"filter[easy_access]","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"3839d167-99e6-445f-b6ac-243cc17a798e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/bays?page[number]=1&page[size]=30&filter[installation_id]=&filter[service]=HotLocker&filter[charging_type]=BaseLine&filter[connectivity_equipment]=KVM&filter[size]=ExtraSmall&filter[status]=Quarantined&filter[easy_access]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["bays"],"query":[{"description":"Change the page","key":"page[number]","value":"1"},{"description":"How many results per page","key":"page[size]","value":"30"},{"description":"The UUID of a Installation","key":"filter[installation_id]","value":""},{"description":"The service that the bay provides","key":"filter[service]","value":"HotLocker"},{"key":"filter[charging_type]","value":"BaseLine"},{"key":"filter[connectivity_equipment]","value":"KVM"},{"key":"filter[size]","value":"ExtraSmall"},{"description":"Status of the Bay","key":"filter[status]","value":"Quarantined"},{"key":"filter[easy_access]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"7df38301-3364-4175-8fd7-0db2e186f742"}],"id":"4ab1e2df-619f-4322-b2f6-c7fb74e971ff","_postman_id":"4ab1e2df-619f-4322-b2f6-c7fb74e971ff","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Location","item":[{"name":"Retrieve a List of Locations","id":"5ff1a363-3b09-476f-9c71-74618667cf44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/locations","urlObject":{"path":["locations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"70de7490-713c-48a6-9add-ea45ab9d4fde","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"installations_count\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"installations_count\": \"\"\n }\n ]\n}"}],"_postman_id":"5ff1a363-3b09-476f-9c71-74618667cf44"},{"name":"Retrieve a Single Location","id":"676ff49f-45e8-4bcc-b823-91eb8f65e14a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/locations/:id","urlObject":{"path":["locations",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"86e44afc-3f64-48b7-b311-0243a9745ba0","description":{"content":"

(Required) The ID of the Location

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e9a4891a-53da-4df9-948c-a9ea3610b7db","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/locations/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["locations",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"location\": {\n \"id\": \"\",\n \"name\": \"\",\n \"installations_count\": \"\"\n }\n}"}],"_postman_id":"676ff49f-45e8-4bcc-b823-91eb8f65e14a"}],"id":"c6c85d84-6db5-4109-8c46-2bc98e34a1a3","_postman_id":"c6c85d84-6db5-4109-8c46-2bc98e34a1a3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}}],"id":"c462d6ca-b78f-4df3-b78f-4eda8abb6997","_postman_id":"c462d6ca-b78f-4df3-b78f-4eda8abb6997","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"User Management","item":[{"name":"Users","item":[{"name":"Individual User","item":[{"name":"Access Groups","item":[{"name":"List Access Groups Associated with a User","id":"a6f0ac4a-df04-40db-8973-f8d95a814cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","description":"

List all access groups associated with a user

\n","urlObject":{"path":["users",":id","access_groups"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"cc074f19-6a66-4324-bbcb-50a2ea40ce88","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b3590864-6f75-4ce6-88ac-f72febdc0216","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"pink\",\n \"reference\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"teal\",\n \"reference\": \"\"\n }\n ]\n}"},{"id":"645eeaba-7425-4fa4-8407-1a4386280901","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"82efa2c8-2042-48f4-a179-a7064c626e6e","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"a6f0ac4a-df04-40db-8973-f8d95a814cbf"},{"name":"Add Access Groups to User","id":"19b508df-68a1-4d7a-983d-88c42c375bcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","description":"

Add access groups to a user

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
access_groupsarrayYesAn array of access group UUID's to be assigned to the user
\n
","urlObject":{"path":["users",":id","access_groups"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"95b8f215-6a0e-431a-aa53-63e81bd1e0d4","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"yellow\",\n \"reference\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"red\",\n \"reference\": \"\"\n }\n ]\n}"},{"id":"7fe1e9a5-2004-4afd-8203-5a20c67028fd","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6f7b8869-ad9c-4f1d-84db-990f63558432","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c5a8f16e-01b4-4b18-9be4-b4f60ebd2a49","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"18bc3f8b-60df-4af5-92b6-e43bb1225992","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"19b508df-68a1-4d7a-983d-88c42c375bcb"},{"name":"Delete Access Groups from User","id":"541e15d6-8055-42c5-b4fa-c2afbbd247eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","description":"

Detach access groups from a user

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
access_groupsarrayYesAn array of access groups UUID's to be removed from the user
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id","access_groups"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6019d959-6f4a-4563-ae27-bf08bcb46dee","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"pink\",\n \"reference\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"teal\",\n \"reference\": \"\"\n }\n ]\n}"},{"id":"ab2b0bc2-4bdf-4c47-9cd3-f80a39f5e8fa","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8e1b3345-6db2-48af-9150-33ab128bce12","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"538587bc-dfdf-42b8-923a-5f98f9292850","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"09b555de-c3bf-4783-8e6d-ee01d9403952","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"541e15d6-8055-42c5-b4fa-c2afbbd247eb"},{"name":"Replace all Users Access Groups","id":"2271466c-e3c0-4197-b3c1-4f33e4104cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","description":"

Remove all the users current access groups and assign new ones

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
access_groupsarrayYesAn array of access groups UUID's to be assigned to the user
\n
","urlObject":{"path":["users",":id","access_groups"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"703eedde-c840-4378-8483-d73ca2bd8ce5","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"yellow\",\n \"reference\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"red\",\n \"reference\": \"\"\n }\n ]\n}"},{"id":"0cfacfa7-8c6a-4efc-af0d-a992f35708b6","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"1203828d-fe5b-4511-ad3b-e2d4df791b80","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9de2776d-4674-49c0-8b30-4294c9dcdadd","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7a2ff2d9-2939-47e3-959b-d9475a597900","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"access_groups\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/access_groups","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","access_groups"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"2271466c-e3c0-4197-b3c1-4f33e4104cff"}],"id":"5fc8a68f-d7f5-4fa1-98e3-12948b77ed7c","description":"

Manage a user's Access Groups

\n","_postman_id":"5fc8a68f-d7f5-4fa1-98e3-12948b77ed7c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Codes / Card Numbers","item":[{"name":"Retrieve Codes for User","id":"0fc7f28a-09b0-4d5c-92e3-67b70392591d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","description":"

List of a codes for a user

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id","codes"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"c68ba84b-9003-4daa-b531-11c2309de365","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"abc3515a-e1f7-4682-b282-86e6437d0e8b","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"codes\": [\n {\n \"key\": \"\",\n \"scannable_type\": \"user\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n },\n {\n \"key\": \"\",\n \"scannable_type\": \"stack\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n ]\n}"}],"_postman_id":"0fc7f28a-09b0-4d5c-92e3-67b70392591d"},{"name":"Create a User Code","id":"cedc1551-98c7-4efc-a1fa-5deeaad56041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","description":"

Create a code and attach to a user

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
keystringYesA unique code to assign to the user
pinstringNoA secondary code to assign to the user
valid_fromdateNoA date that the code is available to be used from by the user
valid_untildateNoA date that the code expires and can no longer be used by the user
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id","codes"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2f4fc57b-4dda-4091-b9c2-57d82a71d28b","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes"],"variable":[{"key":"id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"},{"id":"51e6975b-387a-439f-95d3-dcace86ba98b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ecebfe7e-adc8-4592-8b7d-9a24b2921c26","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2e60e68e-f795-4729-9d52-5b2b982a083a","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4e357434-a042-4c7a-9399-744ebac64a85","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"cedc1551-98c7-4efc-a1fa-5deeaad56041"},{"name":"Retrieve a Single User Code","id":"1f2e2330-49eb-44e6-9fec-e1f77fff0015","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","description":"

Get a single user code

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id","codes",":key"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"763ca23f-11ad-43a7-a1d4-c22dd9197f2b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"id":"a0ece99e-362f-4ccc-88db-934217c03706","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"key"}]}},"response":[{"id":"d9b39959-b34e-4245-b303-68784f0fcc55","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes",":key"],"variable":[{"key":"id"},{"key":"key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"}],"_postman_id":"1f2e2330-49eb-44e6-9fec-e1f77fff0015"},{"name":"Patch a Single User Code","id":"e81be951-6b4b-4881-9b3c-0bd8e809221e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","description":"

Update a single user code

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
keystringYesThe code of the user to be updated
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
pinstringNoThe updated pin for the code
valid_fromdateNoThe updated valid from date for the code
valid_untildateNoThe updated valid until date for the code
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id","codes",":key"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID od the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"

The unique Code for the user

\n","type":"text/plain"},"type":"any","value":"","key":"key"}]}},"response":[{"id":"1301e5bf-f719-404d-a1c8-0c3834bba5b8","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes",":key"],"variable":[{"key":"id"},{"key":"key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"scannable_type\": \"drop_off\",\n \"scannable_id\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n}"}],"_postman_id":"e81be951-6b4b-4881-9b3c-0bd8e809221e"},{"name":"Delete a User Code","id":"e1ab1768-e394-4af9-b206-d756f4392151","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","description":"

Delete a users code

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
keystringYesThe code to be deleted from the user
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id","codes",":key"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"

The unique Code

\n","type":"text/plain"},"type":"any","value":"","key":"key"}]}},"response":[{"id":"bc19c811-0665-4b76-9153-84adf4fed5ce","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes",":key"],"variable":[{"key":"id"},{"key":"key"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"97e58060-f59f-4972-9e37-6804738da581","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes",":key"],"variable":[{"key":"id"},{"key":"key"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"18c72a0e-2e1f-47e1-ac0b-7c9c61c5ec8d","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes",":key"],"variable":[{"key":"id"},{"key":"key"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"311b51f5-9cfe-4a7e-a846-69a879de4868","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/codes/:key","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","codes",":key"],"variable":[{"key":"id"},{"key":"key"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"e1ab1768-e394-4af9-b206-d756f4392151"}],"id":"fd4b6106-a861-481d-9ef6-59390d4a5023","description":"

Manage a user's card numbers

\n","_postman_id":"fd4b6106-a861-481d-9ef6-59390d4a5023","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a Single User","id":"6865bc1f-5b23-463d-9966-1a25ec4615ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id","description":"

This endpoint allows you to retrieve a single user by their UUID within ONARKEN

\n","urlObject":{"path":["users",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"9fa53bfa-1e10-409e-a2f3-3be1a7db4d18","description":{"content":"

(Required) ID of the User

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"14170333-d3d1-4970-ae7b-70e98de8bf7c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n}"},{"id":"94d6cc01-e551-4aa4-8852-e62ca2103a00","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b06c7839-6499-48fe-9baa-6644a6512bfe","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"6865bc1f-5b23-463d-9966-1a25ec4615ca"},{"name":"Replace User Data","id":"e4b3f618-76a2-4413-aa5f-567500251486","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id","description":"

Replace a users data

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringNoA name to replace the current users name
rolestringNoA UUID of a role to assign to the user
\n

{\n \"name\": \"\",\n \"role\": \"\"\n}

\n","urlObject":{"path":["users",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f276e2e3-33ec-4bbe-8376-d37bcbbde35f","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n}"},{"id":"c8da30fd-d394-4e01-8061-07f416eeb173","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2b9ce96e-d95a-47aa-abea-44feb49fee4b","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ae20644e-8986-428f-a39b-dc7b72ef1242","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"65c09f50-7340-4136-8150-f9d961ba4ef6","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"e4b3f618-76a2-4413-aa5f-567500251486"},{"name":"Patch User","id":"9a883cfb-69f6-43a6-8b12-86533315e9bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users/:id","description":"

Update a single users information

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringNoA new name for the user
rolestringNoA new role to assign to the user
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["users",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ba9ac7bf-fd11-4361-8f8d-0df0a23b8ef0","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n}"},{"id":"089ee70b-6476-480d-b0bb-c4863e74ec92","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"024128cf-b35f-4b13-84de-c51ef6900be3","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"62dfeb17-0141-4cb8-a320-a2b662122da7","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"fdf1e916-e4fa-48c8-afa6-5de195c11d8f","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"9a883cfb-69f6-43a6-8b12-86533315e9bc"},{"name":"Delete a User","id":"01ccc4af-675f-4d10-a239-a3e26e3963d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id","description":"

Delete a single user

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user to be deleted
\n

Note: you cannot delete a user with outstanding transactions.

\n","urlObject":{"path":["users",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"64403ef3-36cf-4e36-9ddb-0bbb990936b9","name":"The user was successfully deleted","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"65eac431-bff3-4cf7-82fe-ea41d129f640","name":"User can not be deleted at the moment","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"error\": \"\"\n}"},{"id":"6d35891f-8e96-4914-a826-fd56184cae89","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"55e520dd-b59d-4678-b2ab-ab0f2c6e94f0","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b6508280-c0d2-4e11-9528-fd6c69fab850","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"bd63b7da-dca4-4a11-9e5f-112559b80711","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"01ccc4af-675f-4d10-a239-a3e26e3963d7"},{"name":"Block a User","id":"779125f8-dd62-4961-8c91-b67e840baf3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id/block","description":"

Block a single user

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user to block
\n
","urlObject":{"path":["users",":id","block"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e83a5d27-29f9-429e-a9a4-180ae9bedf2e","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"/users/:id/block","path":["users",":id","block"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n}"},{"id":"18cbd1ba-e84a-4a3b-83a5-96a0cac4b35f","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/block","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","block"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"301b3897-3ec0-4c11-a766-697f8e6d3265","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/block","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","block"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b5a54b84-9b4e-45d5-a35b-d6d9f3ebb66c","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/block","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","block"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"779125f8-dd62-4961-8c91-b67e840baf3c"},{"name":"Unblock a User","id":"d97723e3-2525-43a1-aa58-7f78c67293ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/users/:id/unblock","description":"

Unblock a single user

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the user to be unblocked
\n
","urlObject":{"path":["users",":id","unblock"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the user

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"07e24c6c-99ca-4bd6-a5a1-a99130ffd00c","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"/users/:id/unblock","path":["users",":id","unblock"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n}"},{"id":"35db7f40-fa31-468e-a112-2c391368d08d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/unblock","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","unblock"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"5d16c90f-7c7b-4126-bcd1-e0753719ad48","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/unblock","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","unblock"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ace10669-13ef-4e05-819a-a18b6ac8aeef","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users/:id/unblock","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users",":id","unblock"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d97723e3-2525-43a1-aa58-7f78c67293ea"}],"id":"91ae5058-62d0-40c4-8160-cd7ff048170b","description":"

API endpoints for interactions with individual users

\n","_postman_id":"91ae5058-62d0-40c4-8160-cd7ff048170b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Create a User","id":"ebac06e5-3a2b-4b87-82ca-bd555f70cc04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users","description":"

Create a new user

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesA name for the user
emailemailYesA unique email for the user
rolestringYesA UUID of a role to assign to the user
\n
","urlObject":{"path":["users"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1b3098e6-af77-44b5-9806-a0613877daf3","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n}"},{"id":"d7f114f8-2229-465b-9266-c3e1e3275b53","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"27129348-d60d-4279-9203-7f79fa6e6203","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b411af00-ac52-4a41-9740-1523ba493185","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/users"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"ebac06e5-3a2b-4b87-82ca-bd555f70cc04"},{"name":"Retrieve a List of Users","id":"0a8b1d73-7c8f-4b5e-848b-33acd887b25a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/users","description":"

This endpoint returns a paginated list of all of the users stored within ONARKEN.

\n

This list can be filtered and sorted using the query parameters listed below

\n

Available values for created_via

\n
    \n

  • WebApplication

    \n
    • \n

  • Import

    \n
    • \n

  • LibraryManagementSystem

    \n
    • \n

  • API

    \n
    • \n

  • SelfRegistration

    \n
    • \n

  • Entra

    \n
    • \n
\n","urlObject":{"path":["users"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

Search for a user

\n","type":"text/plain"},"key":"filter[search]","value":""},{"disabled":true,"description":{"content":"

Filter users by their name

\n","type":"text/plain"},"key":"filter[name]","value":""},{"disabled":true,"description":{"content":"

Filter users by their email address

\n","type":"text/plain"},"key":"filter[email]","value":""},{"disabled":true,"description":{"content":"

Filter users created after a date

\n","type":"text/plain"},"key":"filter[created_after]","value":""},{"disabled":true,"description":{"content":"

Filter users created before a date

\n","type":"text/plain"},"key":"filter[created_before]","value":""},{"disabled":true,"description":{"content":"

Filter users by their blocked status

\n","type":"text/plain"},"key":"filter[blocked]","value":""},{"disabled":true,"description":{"content":"

Filter users by a installation UUID that they have permission to access

\n","type":"text/plain"},"key":"filter[has_access_to_installation]","value":""},{"disabled":true,"description":{"content":"

Filter users by a role UUID

\n","type":"text/plain"},"key":"filter[has_role]","value":""},{"disabled":true,"description":{"content":"

Sort users by fields (name, created_at, updated_at, last_active_at)

\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"

Change the page

\n","type":"text/plain"},"key":"page[number]","value":"1"},{"disabled":true,"description":{"content":"

How many results per page

\n","type":"text/plain"},"key":"page[size]","value":"30"}],"variable":[]}},"response":[{"id":"2613f108-fe5d-498c-be79-ba57aec08adf","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/users","host":["https://{{domain}}.onarken.com/api/v1"],"path":["users"],"query":[{"key":"filter[search]","value":"","description":"Search for a user","disabled":true},{"key":"filter[name]","value":"","description":"Filter users by their name","disabled":true},{"key":"filter[email]","value":"","description":"Filter users by their email address","disabled":true},{"key":"filter[created_after]","value":"","description":"Filter users created after a date","disabled":true},{"key":"filter[created_before]","value":"","description":"Filter users created before a date","disabled":true},{"key":"filter[blocked]","value":"","description":"Filter users by their blocked status","disabled":true},{"key":"filter[has_access_to_installation]","value":"","description":"UUID of Installation that user should have access to","disabled":true},{"key":"filter[has_role]","value":"","description":"Filter users by Role Name","disabled":true},{"key":"sort","value":"","description":"Sort users by fields","disabled":true},{"key":"page[number]","value":"1","description":"Change the page","disabled":true},{"key":"page[size]","value":"30","description":"How many results per page","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"WebApplication\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": false,\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"created_via\": \"Import\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_active_at\": \"\",\n \"is_blocked\": \"true\",\n \"access_groups\": [\n \"\",\n \"\"\n ],\n \"role\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"c610e10e-021f-40a5-a2c0-17f1b4baee70","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":"https://{{domain}}.onarken.com/api/v1/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"31b9816e-6aaa-4911-929a-f114098bae7c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":"https://{{domain}}.onarken.com/api/v1/users"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"0a8b1d73-7c8f-4b5e-848b-33acd887b25a"},{"name":"Retrieve a List of Card Numbers","id":"453d9efb-205a-4747-80b4-f3bf9e509bd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/codes","description":"

Retrieves a paginated list of card numbers

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["codes"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

Change the page

\n","type":"text/plain"},"key":"page[number]","value":"1"},{"disabled":true,"description":{"content":"

How many results per page

\n","type":"text/plain"},"key":"page[size]","value":"30"}],"variable":[]}},"response":[{"id":"4df638a6-42fe-4701-a87e-3bbb547b299f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["codes"],"query":[{"key":"page[number]","value":"1","description":"Change the page","disabled":true},{"key":"page[size]","value":"30","description":"How many results per page","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"codes\": [\n {\n \"key\": \"\",\n \"scannable_type\": \"user\",\n \"scannable_id\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n },\n {\n \"key\": \"\",\n \"scannable_type\": \"user\",\n \"scannable_id\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"f01a4df2-8a4d-4a91-a306-1b859d771a8c","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["codes"],"query":[{"key":"page[number]","value":"1","description":"Change the page","disabled":true},{"key":"page[size]","value":"30","description":"How many results per page","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2683a240-a12f-49ef-9fd0-bdf6ee02c519","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/codes","host":["https://{{domain}}.onarken.com/api/v1"],"path":["codes"],"query":[{"key":"page[number]","value":"1","description":"Change the page","disabled":true},{"key":"page[size]","value":"30","description":"How many results per page","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"453d9efb-205a-4747-80b4-f3bf9e509bd7"}],"id":"a603ccef-e7e8-4f0e-a801-8a322a67e6a1","_postman_id":"a603ccef-e7e8-4f0e-a801-8a322a67e6a1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Roles","item":[{"name":"Individual Role","item":[{"name":"Retrieve a Single Role","id":"1380054c-9070-44b0-8c1b-8d254fc8b9d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/roles/:id","description":"

Get a role by its ID

\n","urlObject":{"path":["roles",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"6463c44f-2d2a-41f2-806b-9631d01fefc1","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c96fd77f-0ace-4495-a010-9c65b76c140f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"locker\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n }\n}"},{"id":"518c6c1e-f9f1-4298-83e4-d0ab65eaad90","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4424152d-94b5-4106-9aa6-245b12995a08","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"1380054c-9070-44b0-8c1b-8d254fc8b9d3"},{"name":"Update a Role","id":"1ec5004f-751b-45f0-bcf7-53f1457ca38c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles/:id","description":"

Update an existing role

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the role
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesThe name for the role
permissionsarrayYesAn array of individual permission UUID's to be assigned to the role
typestringYesA string that defines the type of role.

Available Options:
locker maintainer admin
optionsarrayYesAn array that contains the concurrent_loan_limit. Defining how many items a user with this role can loan at one time
referencestringNoA reference name to assign to the role
\n
","urlObject":{"path":["roles",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the role

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7467c18a-914c-44e2-bd3b-1d6a814b3586","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/roles/:id","path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"locker\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n }\n}"},{"id":"a7433993-0282-4e98-9a0c-ced635e88f4d","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"50aecab8-b588-4b3d-8488-c458982ec638","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8bd38bad-73ba-472f-9efd-3df40ee6e907","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"48d495de-9945-4da0-b19d-8286c7684b0c","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"1ec5004f-751b-45f0-bcf7-53f1457ca38c"},{"name":"Delete a Role","id":"094d8398-77ea-48ff-85c2-12c1ae869e5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/roles/:id","description":"

Delete a single role

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the role to be deleted
\n
","urlObject":{"path":["roles",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the role

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cee12f9a-1a81-414b-ab48-771b361f64b9","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e0235df1-8c78-4b59-a8e8-069bca655c9a","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c1cc31a2-1979-4501-bf8d-5fe89c2e01bf","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"3a20cdd7-3106-42a9-a290-b057013a34c3","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"44c23c9b-4624-4903-8ea0-c2437fb708a4","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/roles/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["roles",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"094d8398-77ea-48ff-85c2-12c1ae869e5b"}],"id":"50bec4cd-222f-44bf-81a4-3f0c8f528fff","_postman_id":"50bec4cd-222f-44bf-81a4-3f0c8f528fff","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Roles","id":"af061304-1785-451e-a846-20245c822c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/roles","description":"

List all Roles

\n","urlObject":{"path":["roles"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"bc86882f-2b94-4293-8ce1-e09526683e65","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"roles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"admin\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"admin\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n }\n ]\n}"},{"id":"af10fa49-c112-44cf-b392-818878848b50","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"af061304-1785-451e-a846-20245c822c2c"},{"name":"Create a Role","id":"d434152d-9000-4d9c-912a-21ef7ea7efcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles","description":"

Create a new role

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesThe name for the role
permissionsarrayYesAn array of individual permission UUID's to be assigned to the role
typestringYesA string that defines the type of role.

Available Options:
locker maintainer admin
optionsarrayYesAn array that contains the concurrent_loan_limit. Defining how many items a user with this role can loan at one time
referencestringNoA reference name to assign to the role
\n
","urlObject":{"path":["roles"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5e414ab5-40b3-4dba-ad67-801b7fbf2417","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"locker\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n }\n}"},{"id":"5644af77-d0cc-4a5c-a620-304e91d4b03a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e354d559-1a2a-48a4-a508-2d606619bef8","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"1cee9e02-9032-42b4-8056-b7dacae340a1","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"15df7969-03dd-45f2-a4e2-af84e0f62ef7","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"type\": \"maintainer\",\n \"options\": {\n \"concurrent_loan_limit\": \"\"\n },\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/roles"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"d434152d-9000-4d9c-912a-21ef7ea7efcc"},{"name":"Get Permissions","id":"0a795d4f-601b-4463-a1ea-63b7d2a052fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/permissions","description":"

Get a list of all permissions available for roles

\n","urlObject":{"path":["permissions"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b0eb2311-dde2-45e1-ae08-dce3958301a6","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"permissions\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}"},{"id":"16d28b30-f74f-44ca-b8eb-e60b38e20d91","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/permissions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"196c9cd1-e04f-452b-98bd-3771cb14f145","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/permissions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"0a795d4f-601b-4463-a1ea-63b7d2a052fb"}],"id":"4597a292-c63f-49b4-8780-532d8ca6541b","_postman_id":"4597a292-c63f-49b4-8780-532d8ca6541b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Access Groups","item":[{"name":"Individual Access Group","item":[{"name":"Installations","item":[{"name":"Retrieve a List of Installations Associated with an Access Group","id":"84092b40-5874-4efb-871b-8295580bf038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","description":"

Get installations attached to an access group

\n","urlObject":{"path":["access_groups",":id","installations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"253d1e77-bd39-4c07-bb4f-e16f326ebd63","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"bd1f6b0c-398e-4ccb-98a6-c6db83ce08aa","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/access_groups/:id/installations","path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Sovran\",\n \"secondary_authentication\": \"Pin\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"None\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n ]\n}"},{"id":"d11cdbfe-f2c3-4fda-b548-e071ad0ff009","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a9688f26-6ec9-4f28-bc57-2221efb669f9","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"84092b40-5874-4efb-871b-8295580bf038"},{"name":"Add Installations to Access Group","id":"a0b33d38-79ba-4688-bce8-5e0066fd969a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","description":"

Attach installations to an access group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
installationsarrayYesAn array of installation UUID's to assign to the access group
\n
","urlObject":{"path":["access_groups",":id","installations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the installation

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"73362b10-5484-490a-877e-0122a1581a04","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Sovran\",\n \"secondary_authentication\": \"None\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"None\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Sovran\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"None\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n ]\n}"},{"id":"1b6e6a1c-fcf7-476c-9622-4c8c612dda19","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"77aacfe9-ee47-47d1-ba5e-b9ca4b235c7d","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"67c0a399-385a-4e0a-ba80-7e604a285f81","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4c056ebb-f216-4f1a-96b4-1946217111b3","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"a0b33d38-79ba-4688-bce8-5e0066fd969a"},{"name":"Replace All Access Group Installations","id":"957b39a3-42ef-4bec-b975-c370439a9880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","description":"

Replace all installations attached to an access group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
installationsarrayYesAn array of installation UUID's to assign to the access group
\n
","urlObject":{"path":["access_groups",":id","installations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the access group

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7193c42d-5ee9-49b8-84bb-b15102ea637e","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installations\": {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Sovran\",\n \"secondary_authentication\": \"Pin\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"None\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n}"},{"id":"85439ab1-2b85-41dd-87b1-686d2e2afe28","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"667a2160-c64a-425a-a2bf-190c1c3c9fb1","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8c3f95e1-6bb7-4acc-ab52-2ec57854d9aa","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"23204389-dc19-43c9-8fbb-5d8d0195bd0b","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"957b39a3-42ef-4bec-b975-c370439a9880"},{"name":"Remove Installations from an Access Group","id":"bc9db167-77fa-40b1-a9c2-fcd967f0d73e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","description":"

Delete installations attached to an Access Group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
installationsarrayYesAn array of installation UUID's to be removed from the access group
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["access_groups",":id","installations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the access group

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ee0ae5fe-d481-43cd-9b67-cab16a4cff90","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"installations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Sovran\",\n \"secondary_authentication\": \"None\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"None\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serial_number\": \"\",\n \"hardware_version\": \"Sovran\",\n \"secondary_authentication\": \"FullKeyboard\",\n \"second_scan\": \"\",\n \"manual_id_entry\": \"None\",\n \"timezone\": \"\",\n \"status\": {\n \"online\": \"\",\n \"controllers_connected\": \"\",\n \"last_connected_at\": \"\",\n \"client_version\": \"\"\n },\n \"screen_design_id\": \"\",\n \"location_id\": \"\",\n \"terms_and_conditions_id\": \"\"\n }\n ]\n}"},{"id":"77074a91-687c-4c00-a38d-1fc984ec3408","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"aeefc41a-3b56-4e52-8de9-a71d258b8ddc","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"2faa26f1-70ef-4bf1-b99c-5170f4dfe761","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b41da4b4-fbb6-4aff-93e6-2dbf34e62829","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"installations\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/installations","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","installations"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"bc9db167-77fa-40b1-a9c2-fcd967f0d73e"}],"id":"2aad893c-e4f3-4791-a1da-1de808370e67","_postman_id":"2aad893c-e4f3-4791-a1da-1de808370e67","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Asset Types","item":[{"name":"Retrieve a List of Asset Types Associated with an Access Group","id":"0d02248a-d7d6-44b3-a4c4-3ddeb7023ee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","description":"

List of Asset Types attached to an Access Group

\n","urlObject":{"path":["access_groups",":id","asset_types"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"32322242-6ea3-4f5d-b995-646cd80264e8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a1cf626c-e3c6-441d-a0bc-873421509c00","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -98180356.24243838\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -16338710.74040845\n }\n ]\n}"},{"id":"eb97fb61-3cd4-4aef-b71c-a9105929fc07","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a62f5df6-85d6-4286-8858-24818bfd3f3a","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"0d02248a-d7d6-44b3-a4c4-3ddeb7023ee4"},{"name":"Add Asset Types to Access Group","id":"b8ad4244-4309-4c59-9f39-4d069cce3f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","description":"

Attach Asset Types to an Access Group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
asset_typesarrayYesAn array of asset types UUID's to assign to the access group
\n
","urlObject":{"path":["access_groups",":id","asset_types"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the access group

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d020a1e7-6c5f-41e4-ae4e-114c08cdc2a9","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -98180356.24243838\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -16338710.74040845\n }\n ]\n}"},{"id":"5f520518-347f-4848-bb65-a1554e2fcc9a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4afef501-e927-4fbc-b4a2-a0da32bc511e","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"22617291-382c-40d8-9815-98733911a0fb","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6d575a1c-21f9-4590-af5d-93ede9f2e2a9","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"b8ad4244-4309-4c59-9f39-4d069cce3f17"},{"name":"Replace All Access Group Asset Types","id":"5eca6752-b2d9-47dd-ab5b-cdc4335b07fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","description":"

Replace Asset Types attached to an Access Group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
asset_typesarrayYesAn array of asset types UUID's to assign to the access group
\n
","urlObject":{"path":["access_groups",":id","asset_types"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the access group

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3c88280a-28f1-4108-bade-95be2947b58f","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -98180356.24243838\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -16338710.74040845\n }\n ]\n}"},{"id":"354ce2c1-8f6a-4a27-a4ed-c06fc6053bfe","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ddb1fc61-0747-49e7-aae3-3590edbb532c","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"54ec8ad1-7b84-4413-b7b8-1f078656891e","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"78c516fc-bda9-42c5-ae2d-cc758057e6e9","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"5eca6752-b2d9-47dd-ab5b-cdc4335b07fe"},{"name":"Remove Asset Types from Access Groups","id":"473485fc-2dc7-4b24-9cd9-0fe38545f4dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","description":"

Detach Asset Types from an Access Group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
asset_typesarrayYesAn array of asset types UUID's to be removed from the access group
\n
","urlObject":{"path":["access_groups",":id","asset_types"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the access group

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2ab4a6e2-d22d-4438-8dc5-2f7478a7a75a","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -98180356.24243838\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": -16338710.74040845\n }\n ]\n}"},{"id":"b319c504-7878-4e0c-8b2f-ed9f62fe3b1d","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e2685de1-f168-4b2a-ad2e-779fb874b505","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b6396035-62ec-4a91-ade2-01f29887b693","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a38417cb-22c6-4bab-9a98-ef556b2c8c53","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_groups/:id/asset_types","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_groups",":id","asset_types"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"473485fc-2dc7-4b24-9cd9-0fe38545f4dd"}],"id":"7c6d932c-9a0a-4cda-b60b-91b66d8096b7","_postman_id":"7c6d932c-9a0a-4cda-b60b-91b66d8096b7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve an Access Group","id":"d5204e74-6968-458e-b737-88b54a0c64e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/access_group/:id","description":"

Find an Access Group

\n","urlObject":{"path":["access_group",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"2c3b3113-64ca-4b62-91c1-b216997a6b90","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ea8d4b7e-2ea5-48a0-acb8-1d5c34c042a1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"teal\",\n \"reference\": \"\"\n }\n}"},{"id":"60c75fbe-f4d1-49e4-9e84-0e13b4f832c2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7797e383-997c-4f6e-8b63-24304e8f5dfa","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d5204e74-6968-458e-b737-88b54a0c64e0"},{"name":"Update an Access Group","id":"ef6f698b-85ad-4bb4-98a3-a9c4270b40e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_group/:id","description":"

Update an existing Access Group in ONARKEN

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group to be updated
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesA name for the access group
colourstringYesA colour to assign to the access group.
Available Colours:
blue
red
slate
orange
red
green
teal
indigo
purple
pink
referencestringNoA reference to assign to the access group
\n
","urlObject":{"path":["access_group",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"80c76fc6-6412-40ab-b57f-3e7340ffe4c6","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/access_group/:id","path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_group\": {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"teal\",\n \"reference\": \"\"\n }\n}"},{"id":"2ecbafc7-d5ff-4476-bde6-b7abb3d1929b","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"99b84190-3050-4f62-a415-2561d742d45c","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"435d5011-b88b-44ad-aa9c-cde5e07c7de7","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"cb18ba5f-1a39-40f9-84bc-f64a0cb0b293","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"ef6f698b-85ad-4bb4-98a3-a9c4270b40e9"},{"name":"Delete an Access Group","id":"b1cc7707-d5ac-4df9-b8cf-3dd6fb9a0e48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/access_group/:id","description":"

Delete an Access Group

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the access group to be deleted
\n
","urlObject":{"path":["access_group",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the access group

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"508a21e4-8490-4702-b48e-75066534da80","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"35b714c8-1886-4dc2-b4df-100e6d1d2a16","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f11bf71a-e011-45bb-9451-c3874b1d661f","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"d11800da-7457-4002-84d0-acac27d57da4","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"19a40af6-8b1a-4fa2-8e58-fc42f442d090","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/access_group/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["access_group",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"b1cc7707-d5ac-4df9-b8cf-3dd6fb9a0e48"}],"id":"d0f7940b-d147-44ae-966a-cbe3e5be731b","_postman_id":"d0f7940b-d147-44ae-966a-cbe3e5be731b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Access Groups","id":"0259f202-2217-4447-a035-0edf47755120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/access_groups","description":"

Get a list of access groups

\n","urlObject":{"path":["access_groups"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1b425604-1d02-4bd3-afc0-45df7bb23970","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/access_groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"pink\",\n \"reference\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"teal\",\n \"reference\": \"\"\n }\n ]\n}"},{"id":"918aca70-25c5-4ebe-bacd-08aa6f26d5d0","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/access_groups"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"0259f202-2217-4447-a035-0edf47755120"},{"name":"Create an Access Group","id":"1a701224-a338-45eb-86bb-f773ab26ac1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups","description":"

Create a new Access Group in ONARKEN

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesA name for the access group
colourstringYesA colour to assign to the access group.
Available Colours:
blue
red
slate
orange
red
green
teal
indigo
purple
pink
referencestringNoA reference to assign to the access group
\n
","urlObject":{"path":["access_groups"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"11ce1f04-3243-401d-b6ca-0f474bcf6592","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"access_groups\": {\n \"id\": \"\",\n \"name\": \"\",\n \"colour\": \"pink\",\n \"reference\": \"\"\n }\n}"},{"id":"bb02434b-9a44-403b-859d-b7c3843a10f8","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"3866ac9d-27ff-4fb1-b7a3-3d708694b554","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8bc3a575-6095-4dc0-af2c-ada96247afc1","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"colour\": \"indigo\",\n \"reference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/access_groups"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"1a701224-a338-45eb-86bb-f773ab26ac1f"}],"id":"8a883620-acf2-4918-8ce0-33dfe320ffe9","_postman_id":"8a883620-acf2-4918-8ce0-33dfe320ffe9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}}],"id":"2c7c732f-2ce3-4f72-9b1a-3e10af9eae1c","_postman_id":"2c7c732f-2ce3-4f72-9b1a-3e10af9eae1c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Asset Management","item":[{"name":"Assets","item":[{"name":"Individual Asset","item":[{"name":"Asset Tags","item":[{"name":"Get all tags for Asset","id":"47a1976e-3b4b-4f72-bf0a-99241a4fd7ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","description":"

Get Asset Tags

\n

This endpoint retrieves the tags associated with a specific asset identified by its unique id.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
asset_idstringYesThe id of the asset that you are trying to receive the asset tags for.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets",":id","tags"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a87f0884-226c-4901-b7cf-170e0795f7f4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"codes\": [\n {\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\",\n \"scannable_type\": \"\",\n \"scannable_id\": \"\"\n }\n ]\n}\n"},{"id":"d5d117b4-bfea-4d44-a0d3-bfbbbc00e1eb","name":"Unauthorised","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"19c01ee8-c048-4395-9bd0-276e654b3f40","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"34a8925b-917d-40e5-8b7f-e9e66bec224c","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"47a1976e-3b4b-4f72-bf0a-99241a4fd7ee"},{"name":"Create an Asset Tag","id":"ce5c5620-9162-4906-a281-9cc7fe677d79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","description":"

Create an Asset Tag

\n

This endpoint allows you to create an Asset Tag

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe asset id that you are creating a new tag for in ONARKEN.
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
codestringYesThe asset tag number which must be unique and not used as a tag in ONARKEN. It must be a minimum of 4 characters and less than 32.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets",":id","tags"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the asset

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f67660e9-de51-49ca-9bd6-9ae0f2ba55d9","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"\"\n}\n"},{"id":"05b00d1f-ae0d-4b1e-ba73-e234406d6287","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"dee6407c-5090-4ac6-81b4-6b277963bacd","name":"Unauthorised","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c56d3931-0ed1-48be-ad51-530e064f72a3","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags"],"variable":[{"key":"id","value":"","description":"(Required)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\":\" \"\n}"}],"_postman_id":"ce5c5620-9162-4906-a281-9cc7fe677d79"},{"name":"Delete an individual Asset Tag","id":"b4829900-4471-49e3-a8d5-2648b23320d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags/:code","description":"

Delete an individual Assets Tag

\n

This endpoint allows you to add tags to a specific asset identified by its ID and code.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique reference of the asset
codestringYesThe unique UUID of the tag to be deleted
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets",":id","tags",":code"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"

(Required) - The code to be deleted in ONARKEN

\n","type":"text/plain"},"type":"any","value":"","key":"code"}]}},"response":[{"id":"bf768210-38f1-45e9-8a04-d2b9727e5a9d","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags/:code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags",":code"],"variable":[{"key":"id","value":"","description":"(Required)"},{"key":"code","value":"","description":"(Required) - The code to be deleted in ONARKEN"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5552e813-d814-46e1-844a-4f410dac2ecf","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags/:code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags",":code"],"variable":[{"key":"id","value":"","description":"(Required)"},{"key":"code","value":"","description":"(Required) - The code to be deleted in ONARKEN"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"935aa3bb-cd45-461f-9e90-281d46e91a6b","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags/:code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags",":code"],"variable":[{"key":"id","value":"","description":"(Required)"},{"key":"code","value":"","description":"(Required) - The code to be deleted in ONARKEN"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"3cb8cd71-5b08-4110-b593-52597c9ea566","name":"Unauthorised","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id/tags/:code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id","tags",":code"],"variable":[{"key":"id","value":"","description":"(Required)"},{"key":"code","value":"","description":"(Required) - The code to be deleted in ONARKEN"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b4829900-4471-49e3-a8d5-2648b23320d3"}],"id":"62ad5eb1-ad55-4c2d-8d34-87d22c93eadc","_postman_id":"62ad5eb1-ad55-4c2d-8d34-87d22c93eadc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a Single Asset","id":"13359464-792c-40d8-9fb3-79a4aad83ff7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/assets/:id","description":"

Get an asset

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"bd7a5eff-2fee-4a1c-ab1c-b2e76a5bdabc","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ec9061f3-4126-411f-89c9-c82cfabc3911","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset\": {\n \"id\": \"pMLLN_M/u\",\n \"asset_type_id\": \"\",\n \"charge_level\": \"PartiallyCharged\",\n \"status\": \"Unknown\",\n \"bay_id\": \"\",\n \"installation_id\": \"\",\n \"location_id\": \"\"\n }\n}"}],"_postman_id":"13359464-792c-40d8-9fb3-79a4aad83ff7"},{"name":"Delete a Single Asset","event":[{"listen":"test","script":{"id":"c9b8e666-84a1-4352-81e6-82194e661cd8","exec":["",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e0b3a5e4-a278-4e84-b329-d294e644e398","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/assets/:id","description":"

Delete Asset

\n

This endpoint deletes a single asset within the ONARKEN system.

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe Reference of the asset to be deleted.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique Reference of the asset

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0d7d1d27-da3d-40e2-b18e-fd68b11b4077","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"5268e4c0-de61-43ab-93a4-218d13f0eb75","name":"Unauthorised","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b68f0d10-453a-4b0b-b524-d03d4bb9bace","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b7b2a265-e059-41d7-bff5-0ae388b90369","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"e0b3a5e4-a278-4e84-b329-d294e644e398"}],"id":"8835effc-a70e-4e05-93b9-d0360234712d","_postman_id":"8835effc-a70e-4e05-93b9-d0360234712d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Assets","id":"8cf7f06d-7678-4a59-a7e0-3c537815962b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/assets","description":"

Retrieve a list of assets registered within the ONARKEN system.

\n

Available Statuses

\n
    \n

  • Unknown (Newly created asset)

    \n
    • \n

  • InBay (Currently inside a locker no status defined on Drop Off).

    \n
    • \n

  • OnLoan

    \n
    • \n

  • EndOfLife

    \n
    • \n

  • Deployable

    \n
    • \n

  • Service

    \n
    • \n

  • Lost

    \n
    • \n

  • Deployed

    \n
    • \n

  • Pending Transaction

    \n
    • \n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"key":"filter[status]","value":"Service"},{"disabled":true,"key":"filter[installation_id]","value":""},{"disabled":true,"key":"filter[asset_type_id]","value":""}],"variable":[]}},"response":[{"id":"5a3e8391-f592-4017-9c91-83b9d421a1f9","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets?filter[status]=Service&filter[installation_id]=&filter[asset_type_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets"],"query":[{"key":"filter[status]","value":"Service"},{"key":"filter[installation_id]","value":""},{"key":"filter[asset_type_id]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"assets\": [\n {\n \"id\": \"-_M/u\",\n \"asset_type_id\": \"\",\n \"charge_level\": \"AlmostCharged\",\n \"status\": \"Unknown\",\n \"bay_id\": \"\",\n \"installation_id\": \"\",\n \"location_id\": \"\"\n },\n {\n \"id\": \"_-N-M/u\",\n \"asset_type_id\": \"\",\n \"charge_level\": \"AlmostCharged\",\n \"status\": \"InBay\",\n \"bay_id\": \"\",\n \"installation_id\": \"\",\n \"location_id\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"49a2a779-11f5-4c49-b875-03184b963b15","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/assets?filter[status]=Service&filter[installation_id]=&filter[asset_type_id]=","host":["https://{{domain}}.onarken.com/api/v1"],"path":["assets"],"query":[{"key":"filter[status]","value":"Service"},{"key":"filter[installation_id]","value":""},{"key":"filter[asset_type_id]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"8cf7f06d-7678-4a59-a7e0-3c537815962b"},{"name":"Create an Asset","id":"db3e0c37-97e6-4199-89fd-9aa62e7c5f4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"LAP-0001\",\n \"asset_type_id\": \"\",\n \"tag\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/assets","description":"

Create an Asset

\n

This endpoint allows a single asset to be created inside of ONARKEN.

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the asset to be created.
asset_type_idstringYesThe asset type is to relate to the new asset.
tagstringNoAdd an asset tag to this asset when creating
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["assets"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c6b0c59f-98de-4092-8056-62f80953b0e4","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"LAP-0001\",\n \"asset_type_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/assets"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset\": {\n \"id\": \"LAP-0001\",\n \"asset_type_id\": \"\",\n \"charge_level\": \"PartiallyCharged\",\n \"status\": \"Unknown\",\n \"bay_id\": \"\",\n \"installation_id\": \"\",\n \"location_id\": \"\"\n }\n}"},{"id":"ae7c869c-d39d-4be0-9705-98eb50a2485b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"LAP-0001\",\n \"asset_type_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/assets"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"49407860-68f4-415d-a9bc-0588bedfc4bb","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"LAP-0001\",\n \"asset_type_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/assets"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"f8dd7a5b-6b40-455b-a63e-590c254f41a2","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"LAP-0001\",\n \"asset_type_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/assets"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"db3e0c37-97e6-4199-89fd-9aa62e7c5f4f"}],"id":"c775b338-415b-49c2-976a-155c34558f22","_postman_id":"c775b338-415b-49c2-976a-155c34558f22","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Asset Categories","item":[{"name":"Individual Asset Category","item":[{"name":"Retrieve an Asset Category","id":"10b832fd-2724-40fb-afd9-76a9470ab383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","description":"

Get a single asset category

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_categories",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"eda69dea-1588-48e6-99bb-9cf43de0ce20","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"be91cbfb-af9a-4e16-a0b4-482fc973a8da","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_category\": {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\"\n }\n}"},{"id":"7721425a-f036-4e52-97c1-aa566dd55169","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"947b4eb6-b35e-4fd7-bd2e-07a2599c9dab","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0f1b1423-6f4f-402e-81af-e7db8f526566","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a7402b61-6f4d-42ec-9341-a9bb453ef39f","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"10b832fd-2724-40fb-afd9-76a9470ab383"},{"name":"Patch an Asset Category","id":"2f0fc101-caef-496d-b92b-6e8294858daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","description":"

Update an asset category

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the asset category
\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesA new name for the asset category to be updated to
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_categories",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the asset category

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cefc9067-8443-4673-a902-8c4e58eef78d","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/asset_categories/:id","path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_category\": {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\"\n }\n}"},{"id":"77167ec9-baf1-4862-98d5-b3ac4c625fb1","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"de03c1bd-2a8f-4ecc-8929-a2a4d4967265","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7f0ac2ae-a740-415c-946d-357d95c2eae9","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ad17c29c-ae97-4285-950c-fb4eb1caa754","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_categories/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_categories",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"2f0fc101-caef-496d-b92b-6e8294858daa"}],"id":"81c89456-e553-4e7f-b037-74c807159714","_postman_id":"81c89456-e553-4e7f-b037-74c807159714","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Asset Categories","id":"27b55187-74f1-4854-b954-95c99634bd35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/asset_categories","description":"

Get a list of asset categories

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_categories"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"670030b6-989c-4f0b-8e9e-a55e46bf6291","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/asset_categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_categories\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"90ccc7dc-ace4-43a3-bd33-6939be23dd50","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/asset_categories"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"27b55187-74f1-4854-b954-95c99634bd35"},{"name":"Create an Asset Category","id":"58cacd3e-4da7-4ef1-b6f3-685e9e59cc79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_categories","description":"

Create an asset category

\n

Request Body Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestringYesA unique name for an asset category
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_categories"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a4412f34-6f6a-4ddd-95fb-d1eeb76ef005","name":"Create an Asset Category","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_categories"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"asset_category\": {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\"\n }\n}"}],"_postman_id":"58cacd3e-4da7-4ef1-b6f3-685e9e59cc79"}],"id":"1cf9afdc-8819-4f0f-9938-5781585a1c8b","_postman_id":"1cf9afdc-8819-4f0f-9938-5781585a1c8b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Asset Types","item":[{"name":"Individual Asset Type","item":[{"name":"Retrieve an Asset Type","id":"e10e6338-1b65-4652-82d1-b4f31603a323","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","description":"

Get an asset type

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_types",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"id":"37820443-1427-4e25-87d8-224bbf2563ad","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"67d7fca9-9e2e-478e-b256-03b443310740","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_type\": {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": true\n }\n}"},{"id":"c60bcabb-a512-48bf-bfff-ff8173c29116","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"7e6e4308-5080-4674-b7a8-accde65221d8","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"e10e6338-1b65-4652-82d1-b4f31603a323"},{"name":"Create an Asset Type","id":"1aef9093-8250-4c02-82d0-e10df7c4c447","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_type","description":"

Create Asset Type

\n

This endpoint creates a single Asset Type in ONARKEN.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
namestring (min: 3, max:32)YesThe name for the new asset type.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_type"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d7efd789-77ff-4983-a00c-081d1d9cb52e","name":"Created","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","protocol":"https","host":["{{domain}}","onarken","com"],"path":["api","v1","asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_type\": {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n }\n }\n}"},{"id":"302df42e-f72f-42a4-8979-f25c352d38be","name":"Unauthorised","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c31d04e1-9321-4a98-aec1-2c3ef5813e5f","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ececcaed-1da2-479a-80bc-909a75dfb3b6","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"1aef9093-8250-4c02-82d0-e10df7c4c447"},{"name":"Delete an Asset Type","id":"4c683e05-52e4-49db-810d-b8c0f4ed38b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/asset_type/:id","description":"

Delete Asset Type

\n

This endpoint deletes a single Asset Type in ONARKEN.

\n

Path Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe unique UUID of the asset type to be deleted in ONARKEN
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_type",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique UUID of the asset type

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d4404a69-5777-4d2b-bd1a-d78eb650ce2b","name":"No Content","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_type/:id","protocol":"https","host":["{{domain}}","onarken","com"],"path":["api","v1","asset_type",":id"],"variable":[{"key":"id","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":""},{"id":"f94c6df4-9f8a-41f0-8d47-b430398cd9d6","name":"User unauthorised","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"c41a17df-019e-4855-a994-a3379904ba8d","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0787a9b2-9624-4baa-8f95-7274b17ec002","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"de70a7d7-fb9b-4ab5-abb2-32bce11208cc","name":"Asset Type was not deletable","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"4c683e05-52e4-49db-810d-b8c0f4ed38b0"},{"name":"Patch an Asset Type","id":"973730b9-d34c-4998-b662-9631f0e5a385","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","description":"

Update an asset type

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_types",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9d78e1aa-83ae-4970-a5eb-ece10cfa9dcd","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_type\": {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n },\n \"compatible\": true\n }\n}"},{"id":"d75fd5c2-66da-4dfa-a6ae-e8b7a4f2b0cc","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"675a5aa8-0154-44bd-a75d-b8fe1c074b56","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b3eb81aa-8fc3-4d7d-b14b-3d7848c2eddc","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a050816c-a287-43df-836a-93d9ace8ae42","name":"Unprocessable Entity (WebDAV)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id"],"variable":[{"key":"id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"errors\": {\n \"field\": [\n \"\",\n \"\"\n ]\n }\n}"}],"_postman_id":"973730b9-d34c-4998-b662-9631f0e5a385"},{"name":"Toggle an Asset Type to Adhoc (BETA)","id":"a4ecce83-485e-4962-95dd-ea8bc5e1f420","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"adhoc_vending\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/adhoc","description":"

Toggle an Asset Type to Adhoc Vending

\n

This enpoint toggles an asset type to Adhoc Vending in ONARKEN.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the asst type that you are trying to update in ONARKEN.
\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
adhoc_vendingbooleanYesA boolean value to toggle the adhoc vending to on or off in ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_types",":id","adhoc"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the Asset Type.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fb37985b-02a4-4d30-b9e8-6f24bff4c76d","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"adhoc_vending\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vending/:id/adhoc","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vending",":id","adhoc"],"variable":[{"key":"id","value":"9d5a03ae-87a2-307a-963d-f8428834dd35"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"d04d71f0-8c38-4ef8-a2a0-02b36581ab09","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"adhoc_vending\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vending/:id/adhoc","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vending",":id","adhoc"],"variable":[{"key":"id","value":"9d5a03ae-87a2-307a-963d-f8428834dd35"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"6449f533-18a6-4d6e-b9ea-38326b7dbfed","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"adhoc_vending\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vending/:id/adhoc","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vending",":id","adhoc"],"variable":[{"key":"id","value":"","description":"The unique id of the Asset Type."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"771f8a93-6c29-4642-8c93-56554bb71e0e","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"adhoc_vending\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vending/:id/adhoc","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vending",":id","adhoc"],"variable":[{"key":"id","value":"","description":"The unique id of the Asset Type."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"a4ecce83-485e-4962-95dd-ea8bc5e1f420"},{"name":"Toggle an Asset Type to be a High Value Item (BETA)","id":"d71eea3d-505c-4250-802d-db6a35108119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"high_value\": \"\"\n}"},"url":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/high_value","description":"

Toggle an Asset Type to be a High Value Item

\n

This endoint toggles an asset type to be a high value item inside a vending machine.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the asset type you are trying to toggle to be high value in ONARKEN
\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
high_valuebooleanYesA boolean value to indicate if the asset type should be high value in ONARKEN.
\n
","urlObject":{"path":["asset_types",":id","high_value"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the asset type.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b5631905-bd0c-42bc-a525-68f66d0a6581","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/high_value","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","high_value"],"variable":[{"key":"id","value":"","description":"The unique id of the asset type."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"8fa6335e-4ea5-446e-abc4-222308d2c820","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/high_value","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","high_value"],"variable":[{"key":"id","value":"","description":"The unique id of the asset type."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"089e2747-8d15-49cc-adf9-c7a7de267a69","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/high_value","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","high_value"],"variable":[{"key":"id","value":"","description":"The unique id of the asset type."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e8d93e14-7212-42b1-b498-4e9cba8d97fa","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_types\": [\n \"\",\n \"\"\n ]\n}"},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/high_value","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","high_value"],"variable":[{"key":"id","value":"","description":"The unique id of the asset type."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d71eea3d-505c-4250-802d-db6a35108119"},{"name":"Set an Asset Type Vending Limits (BETA)","id":"06dad0ef-3751-486c-a0b4-c0e85523170a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit_quantity\": \"\",\n \"limit_days\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/vending_limit","description":"

Set an Asset Types Vending Limit Quantity and Days

\n

This endpoint allows you to set an asset types vending quantity limit over how many days.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the asset type in ONARKEN
\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
limit_quantityintegerYesA integer value that sets the maximum vend quantity for the asset type by a single user.
limit_daysintegerYesA integer value that sets the amount of days that the vending limit is in place for the selected asset type.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_types",":id","vending_limit"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the Asset Type

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e4b57018-33bd-49ce-996c-20fad2bcf4e1","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit_quantity\": \"\",\n \"limit_days\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/vending_limit","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","vending_limit"],"variable":[{"key":"id","value":"","description":"The unique id of the Asset Type"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"3d70b630-0226-481d-af5b-ec3077987672","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit_quantity\": \"\",\n \"limit_days\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/vending_limit","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","vending_limit"],"variable":[{"key":"id","value":"","description":"The unique id of the Asset Type"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"de89618c-4c44-4496-ad0c-b8895c0396a0","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit_quantity\": \"\",\n \"limit_days\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/vending_limit","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","vending_limit"],"variable":[{"key":"id","value":"","description":"The unique id of the Asset Type"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9aa1f3d2-03ba-48b8-abf4-6e4e1f86a5b1","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit_quantity\": \"\",\n \"limit_days\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{domain}}.onarken.com/api/v1/asset_types/:id/vending_limit","host":["https://{{domain}}.onarken.com/api/v1"],"path":["asset_types",":id","vending_limit"],"variable":[{"key":"id","value":"","description":"The unique id of the Asset Type"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"06dad0ef-3751-486c-a0b4-c0e85523170a"}],"id":"c8a2bfcc-e25e-4e2b-baa0-70fbc7296034","_postman_id":"c8a2bfcc-e25e-4e2b-baa0-70fbc7296034","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Asset Types","id":"1658df28-4fcf-43cb-a6b2-c44dd74e071f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{domain}}.onarken.com/api/v1/asset_types","description":"

Get a list of asset types

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["asset_types"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"28add7ae-53df-4584-8186-9acefbc3e7f5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":"https://{{domain}}.onarken.com/api/v1/asset_types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"asset_category_id\": \"\",\n \"loan_rule_id\": \"\",\n \"smartline\": {\n \"compatible\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ],\n \"model\": \"\"\n }\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"prev\": \"\",\n \"last\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"active\": \"\"\n }\n ],\n \"path\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\"\n }\n}"},{"id":"678c11b6-104f-44ef-99a8-fc2615a13533","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://{{domain}}.onarken.com/api/v1/asset_types"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"1658df28-4fcf-43cb-a6b2-c44dd74e071f"}],"id":"2924729f-1da9-4ad0-91e2-83715fd1b0b6","_postman_id":"2924729f-1da9-4ad0-91e2-83715fd1b0b6","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}}],"id":"30207c87-7634-4be6-bd51-ba24bd23a90b","_postman_id":"30207c87-7634-4be6-bd51-ba24bd23a90b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Vending (BETA)","item":[{"name":"Vend Requests","item":[{"name":"Individual Vend Request","item":[{"name":"Allocations","item":[{"name":"Retrieve a Single Vend Allocation","id":"5c657028-3a8d-4c75-b746-f8c21e512af5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId","description":"

Get a single Vend Allocation

\n

This endpoint retrieves a single vend allocation, by suppyling the required vend allocation ID

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
vendRequestIdstringYesThe id of the vend request that you are trying to receive from ONARKEN.
vendAllocationidstringyestThe unique id of the vend allocation that you are trying to receive from ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the vend request.

\n","type":"text/plain"},"type":"any","value":"","key":"vendRequestId"},{"description":{"content":"

The unique id of the vend allocation.

\n","type":"text/plain"},"type":"any","value":"","key":"vendAllocationId"}]}},"response":[{"id":"9962bd36-3e52-46a1-8f1f-97777799cddc","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"allocation\": [\n {\n \"id\": \"\",\n \"vend_request_id\": \"\",\n \"status\": \"\",\n \"asset_type_id\": \"\",\n \"approved_by_id\": \"\",\n \"approved_at\": \"\"\n }\n ]\n}"},{"id":"5aa34379-4e16-480c-adab-d67489b26884","name":"Forbidden","originalRequest":{"method":"GET","header":[]},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9d2665d4-8c8d-4eb9-a848-b8e31925c746","name":"Not Found","originalRequest":{"method":"GET","header":[]},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"eaf26408-eae5-47c9-8de5-27aba626eb8e","name":"Unauthorized","originalRequest":{"method":"GET","header":[]},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"5c657028-3a8d-4c75-b746-f8c21e512af5"},{"name":"Retrieve a List of Vend Allocations","id":"da34ce74-e143-44b4-87ee-8843c8551263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations","description":"

Retrieve a list of Vend Allocations

\n

This enpoint retrieves a list of Vend Allocations from ONARKEN.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
vendRequestIdstringYesThe id of the vend request that you are trying to receive from ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":vendRequestId","allocations"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the vend request.

\n","type":"text/plain"},"type":"any","value":"","key":"vendRequestId"}]}},"response":[{"id":"39ff7eff-cfa4-4722-87ff-8a63b4430296","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"allocations\": [\n {\n \"id\": \"\",\n \"vend_request_id\": \"\",\n \"status\": \"\",\n \"asset_type_id\": \"\",\n \"approved_by_id\": \"\",\n \"approved_at\": \"\"\n }\n ]\n}"},{"id":"45e95b9e-247f-40c7-a371-df22f7815a41","name":"Forbidden","originalRequest":{"method":"GET","header":[]},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"50dd70e2-22f8-472f-8d02-691d7f7ab1c0","name":"Not Found","originalRequest":{"method":"GET","header":[]},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e7327722-e264-464a-b61a-2cae0232d8a9","name":"Unauthorized","originalRequest":{"method":"GET","header":[]},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"da34ce74-e143-44b4-87ee-8843c8551263"},{"name":"Cancel a Vend Allocation","id":"7d9e74c4-53e6-4d77-94d9-0470b3e8a8ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocation","description":"

Cancel a Single Vend Allocation

\n

This endpoint cancels a single vend allocation, by suppyling the required vend request id and vend allocation ID.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
vendRequestIdstringYesThe id of the vend request that you are trying to retrieve in ONARKEN.
vendAllocationIdstringyesThe id of the vend allocation that you are trying to cancel in ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":vendRequestId","allocations",":vendAllocation"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the vend request.

\n","type":"text/plain"},"type":"any","value":"","key":"vendRequestId"},{"description":{"content":"

The unique id of the vend allocation.

\n","type":"text/plain"},"type":"any","value":"","key":"vendAllocation"}]}},"response":[{"id":"c3a452d0-ee37-45da-ba98-e7502c7af99f","name":"OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","cancel"],"variable":[{"key":"id","value":"d98d73a9-d944-361f-8e3b-5f73ecb51edd","description":"The unique id of the vend allocation to be cancelled."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"f77b1728-7b21-41e0-9651-a739230ecc03","name":"Forbidden","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","cancel"],"variable":[{"key":"id","value":"d98d73a9-d944-361f-8e3b-5f73ecb51edd","description":"The unique id of the vend allocation to be cancelled."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"fc6f440f-c3b6-4bf1-a39a-3410a1bd7f19","name":"Cancel a Vend Allocation","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","cancel"],"variable":[{"key":"id","value":"d98d73a9-d944-361f-8e3b-5f73ecb51edd","description":"The unique id of the vend allocation to be cancelled."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e6b243d4-fb9c-41fa-9d14-5e5ddb6463f9","name":"Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/cancel","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","cancel"],"variable":[{"key":"id","value":"d98d73a9-d944-361f-8e3b-5f73ecb51edd","description":"The unique id of the vend allocation to be cancelled."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"7d9e74c4-53e6-4d77-94d9-0470b3e8a8ee"},{"name":"Approve a Vend Allocation","id":"cc3ce4ee-ffa6-4c1e-b49c-37284c4fab43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","description":"

Approve a Vend Allocation

\n

This endpoint approves a single vend allocation, by suppyling the required vend request id and vend allocation ID.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
vendRequestIdstringYesThe id of the vend request that you are trying to retrieve in ONARKEN.
vendAllocationIdstringyesThe id of the vend allocation that you are trying to approve in ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the Vend Request

\n","type":"text/plain"},"type":"any","value":"","key":"vendRequestId"},{"description":{"content":"

The unique id of the vend allocation

\n","type":"text/plain"},"type":"any","value":"","key":"vendAllocationId"}]}},"response":[{"id":"f2b11869-cce3-43de-8e42-42dbc37c4272","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"024dc230-9900-4318-a722-5e6c17d5aba0","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"e9680728-27ad-4b74-a3cc-4411824e772b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"9ef45202-0dad-4f0f-a6da-6d9f0f5ccd9a","name":"Approve a Vend Allocation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"cc3ce4ee-ffa6-4c1e-b49c-37284c4fab43"},{"name":"Reject a Vend Allocation","id":"d345e3b1-50d9-4a17-a7cb-de367f50376a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/reject","description":"

Approve a Vend Allocation

\n

This endpoint approves a single vend allocation, by suppyling the required vend request id and vend allocation ID.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
vendRequestIdstringYesThe id of the vend request that you are trying to retrieve in ONARKEN.
vendAllocationIdstringyesThe id of the vend allocation that you are trying to approve in ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","reject"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the Vend Request

\n","type":"text/plain"},"type":"any","value":"","key":"vendRequestId"},{"description":{"content":"

The unique id of the vend allocation

\n","type":"text/plain"},"type":"any","value":"","key":"vendAllocationId"}]}},"response":[{"id":"7ff2f670-b5e1-4d45-a8a1-59a0549bdf36","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"27a28bc4-f2d7-4ac5-8e0b-d2e99c2a0ce4","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a0fceb72-b595-44b6-8055-55c2e1baf646","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"d6f14153-d883-46a8-9aa2-c4ec7d42c548","name":"Approve a Vend Allocation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:vendRequestId/allocations/:vendAllocationId/approve","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":vendRequestId","allocations",":vendAllocationId","approve"],"variable":[{"key":"vendRequestId","value":"","description":"The unique id of the Vend Request"},{"key":"vendAllocationId","value":"","description":"The unique id of the vend allocation"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"d345e3b1-50d9-4a17-a7cb-de367f50376a"}],"id":"7e373591-21ac-467d-980f-58659458cc0a","_postman_id":"7e373591-21ac-467d-980f-58659458cc0a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a Single Vending Request","id":"ffa2d3e9-533b-482a-937e-689357d2ebcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id","description":"

Get a single Vend Request

\n

This endpoint retrieves a single vend request, by suppyling the required vend request ID

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the vend request that you are trying to receive from ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":id"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The id of the required vending request.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"74174e49-dd87-43c5-b0c4-769ef3c3cf19","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"vend_request\": [\n {\n \"id\": \"\",\n \"location_id\": \"\",\n \"requested_for_id\": \"\",\n \"requested_by_id\": \"\",\n \"expires_at\": \"\"\n }\n ]\n}"},{"id":"4092b47b-7526-4ccf-8c9c-a90c5a1b5b4b","name":"Forbidden","originalRequest":{"method":"GET","header":[]},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"b8a1f894-26a4-45e9-9b30-7354317a02ff","name":"Unauthorized","originalRequest":{"method":"GET","header":[]},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"dcc51a87-f468-4511-b756-e615be0c688e","name":"Not Found","originalRequest":{"method":"GET","header":[]},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"ffa2d3e9-533b-482a-937e-689357d2ebcb"},{"name":"Retrieve a Code for a Vend Request","id":"b070b9f3-447b-44ba-a120-7a0bc21ea747","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/code","description":"

Get the Code for a single Vend Request

\n

This endpoint retrieves the code for a single vend request, by suppyling the required vend request ID

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the vend request code that you are trying to receive from ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests",":id","code"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the vend requests code

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6a7fd608-4422-416b-99dd-c95e287f1f1e","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","code"],"variable":[{"key":"id","value":"","description":"The unique id of the vend requests code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": {\n \"key\": \"\",\n \"pin\": \"\",\n \"valid_from\": \"\",\n \"valid_until\": \"\",\n \"scannable_type\": \"\"\n }\n}"},{"id":"328d5d58-38b5-43e2-b061-674a355bbbb8","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","code"],"variable":[{"key":"id","value":"","description":"The unique id of the vend requests code"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"19b4e0ff-7aaf-488d-b22b-81a48a5f1a8b","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","code"],"variable":[{"key":"id","value":"","description":"The unique id of the vend requests code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8f546a26-dba4-46a4-b4a4-e9544492e438","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{domain}}.onarken.com/api/v1/vend_requests/:id/code","host":["https://{{domain}}.onarken.com/api/v1"],"path":["vend_requests",":id","code"],"variable":[{"key":"id","value":"","description":"The unique id of the vend requests code"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"b070b9f3-447b-44ba-a120-7a0bc21ea747"},{"name":"Retrieve a Vending ticket","id":"80a41880-2cea-4d59-9918-bf8d85a887d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/:id/ticket","description":"

Get a Vending Ticket for a Single Vend Request

\n

This endpoint retrieves a vending ticket for a single vend request, by suppyling the required vend request ID

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
idstringYesThe id of the vend request ticket that you are trying to receive from ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":[":id","ticket"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[{"description":{"content":"

The unique id of the vend request.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2ea6e86c-446b-4259-bc10-54f5ccfda0bf","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"\"\n}"},{"id":"0b073b3e-49a1-4c3e-a2e4-0d0df3ccd5e8","name":"Forbidden","originalRequest":{"method":"GET","header":[]},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"d03ffe6e-1dd8-4b62-ae5c-832109ae59e1","name":"Unauthorized","originalRequest":{"method":"GET","header":[]},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"fb522c48-c5b8-4e9b-835a-8c33847089e0","name":"Not Found","originalRequest":{"method":"GET","header":[]},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"80a41880-2cea-4d59-9918-bf8d85a887d6"}],"id":"3d6c50f8-32ad-4b13-9e88-c0a8ff2caed9","_postman_id":"3d6c50f8-32ad-4b13-9e88-c0a8ff2caed9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"Retrieve a List of Vending Requests","id":"261432db-6a44-4c26-aeb0-b5332dcb7d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests","description":"

Get a list of Vending Requests

\n

This endpoint retreives a list of all current vending requests from ONARKEN.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9247278b-92b6-42c8-a688-6110c184222c","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"vend_requests\": [\n {\n \"id\": \"\",\n \"location_id\": \"\",\n \"requested_for_id\": \"\",\n \"requested_by_id\": \"\",\n \"expires_at\": \"\"\n }\n ]\n}"},{"id":"0a317ac4-8161-4258-8049-5fae64dee89e","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"a8823a8f-5ba3-469b-ba50-f9a15454a49b","name":"Forbidden","originalRequest":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"0c885b59-9732-4c0f-99ee-554c75469861","name":"Not Found","originalRequest":{"method":"GET","header":[],"url":"https://{{domain}}.onarken.com/api/v1/ven_requests"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"261432db-6a44-4c26-aeb0-b5332dcb7d2c"},{"name":"Create a new Vend Request","id":"a61f9177-b621-4fd3-ba7c-9184508fe59b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"\",\n\t\t\"vend_list\": [\n\t\t\t{\n\t\t\t\t\"asset_type_id\" :\"\",\n\t\t\t\t\"quantity\": \"\"\n\t\t\t}\n\t\t],\n \"requested_for_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/vend_requests","description":"

Create a new Vend Request

\n

This endpoint allows you to create a new Vend Request in ONARKEN.

\n

Request Body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
location_iduuidYesThe unique id of the location of the vending machine.
vend_listobject/arrayYesA list of asset types and a quantity amount of items to be added to the vend request.
requested_for_iduuidNoThe unique id of the user who the vend request is for.
expires_atdateNoA date for which the vend request should automatically expire, if it has not been collected.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["vend_requests"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c6920965-a48e-4449-9c7a-de035df43ae2","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"\",\n\t\t\"vend_list\": [\n\t\t\t{\n\t\t\t\t\"asset_type_id\" :\"\",\n\t\t\t\t\"quantity\": \"\"\n\t\t\t}\n\t\t],\n \"requested_for_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"vend_request\": [\n {\n \"id\": \"\",\n \"location_id\": \"\",\n \"requested_for_id\": \"\",\n \"requested_by_id\": \"\",\n \"expires_at\": \"\"\n }\n ]\n}"},{"id":"15264ce3-0b9a-484a-8c5d-8c8642257e57","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"\",\n\t\t\"vend_list\": [\n\t\t\t{\n\t\t\t\t\"asset_type_id\" :\"\",\n\t\t\t\t\"quantity\": \"\"\n\t\t\t}\n\t\t],\n \"requested_for_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"94c8e02b-a583-48ab-a732-47db38044daa","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"\",\n\t\t\"vend_list\": [\n\t\t\t{\n\t\t\t\t\"asset_type_id\" :\"\",\n\t\t\t\t\"quantity\": \"\"\n\t\t\t}\n\t\t],\n \"requested_for_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"10938d00-9de8-4dc8-a012-e2c20d19edd8","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"\",\n\t\t\"vend_list\": [\n\t\t\t{\n\t\t\t\t\"asset_type_id\" :\"\",\n\t\t\t\t\"quantity\": \"\"\n\t\t\t}\n\t\t],\n \"requested_for_id\": \"\",\n \"expires_at\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}.onarken.com/api/v1/vend_requests"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"a61f9177-b621-4fd3-ba7c-9184508fe59b"}],"id":"cd29dd14-b7b1-44ea-a69b-b346c8730b33","_postman_id":"cd29dd14-b7b1-44ea-a69b-b346c8730b33","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}},{"name":"List of Available Stock by Location","id":"587f320c-de1e-4ef8-acbb-3963d9d80030","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/stock/by_location","description":"

Get a list of Available Stock by Location

\n

This endpoint retreives a list of all available stock in each location from ONARKEN.

\n

Filters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
location_idstringnoThe id of the location to filter the vending stock by in ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stock","by_location"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

The unique id of the location.

\n","type":"text/plain"},"key":"location_id","value":""}],"variable":[]}},"response":[{"id":"7166b9e6-8def-488e-b995-027a2f8c102d","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"available_quantity\": \"\",\n \"total_quantity\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"6581e9d8-7b02-47dc-a0d7-8e217aad60a5","name":"Forbidden","originalRequest":{"method":"GET","header":[]},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"4609ce36-e561-4bcf-9e9e-32e4e79eeb1c","name":"Not Found","originalRequest":{"method":"GET","header":[]},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"ad898060-9fa7-424d-a9f5-08003db63b59","name":"Unauthorized","originalRequest":{"method":"GET","header":[]},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"587f320c-de1e-4ef8-acbb-3963d9d80030"},{"name":"List of Available Stock by Vending Machine","id":"c53ba1c5-e2f5-4ee3-b3e1-215a2f0d230f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{domain}}.onarken.com/api/v1/stock/by_machine","description":"

Get a list of Available Stock by Vending Machine

\n

This endpoint retreives a list of all available stock in each vending machine from ONARKEN.

\n

Filters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
machine_idstringnoThe id of the vending machine to filter the stock in ONARKEN.
\n
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}},"urlObject":{"path":["stock","by_machine"],"host":["https://{{domain}}.onarken.com/api/v1"],"query":[{"disabled":true,"description":{"content":"

The id of the vending machine id.

\n","type":"text/plain"},"key":"machine_id","value":""}],"variable":[]}},"response":[{"id":"113d735c-961a-4da6-bb3f-00ef6e52169e","name":"OK","originalRequest":{"method":"GET","header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vending_machines\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"asset_types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"available_quantity\": \"\",\n \"total_quantity\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"f97b0a88-9fe0-4230-a03f-dd4904a66877","name":"Forbidden","originalRequest":{"method":"GET","header":[]},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"8444132a-6a57-4956-9cb1-5e85248bfd79","name":"Not Found","originalRequest":{"method":"GET","header":[]},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"},{"id":"782dd515-f3a2-4eff-bf7f-296afc4c391f","name":"Unauthorized","originalRequest":{"method":"GET","header":[]},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\"\n}"}],"_postman_id":"c53ba1c5-e2f5-4ee3-b3e1-215a2f0d230f"}],"id":"33cee149-4362-4883-acbd-105c7d1e2d01","_postman_id":"33cee149-4362-4883-acbd-105c7d1e2d01","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","id":"da8a18c2-8153-4f4b-9c2d-6a57a807c348","name":"ONARKEN API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]}},"variable":[{"key":"baseUrl","value":"https://{{domain}}.onarken.com/api/v1"}]}