Self Service (1.1-oas3)

Download OpenAPI specification:Download

An API to allow users to check items in and out on their own.

Public

Operations that can be called without logging in

Log in to get initial access token.

Request Body schema:
application/json

username required	string The user's myTurn.com username, or their membership ID with their organization/tool library.
password required	string The user's myTurn.com password.

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"username": "string",
"lastName": "string",
"firstName": "string",
"displayName": "string",
"emailAddress": "string",
"expires_in": 0,
"token_type": "Bearer",
"access_token": "string",
"roles": ["string"
],
"isAdmin": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
},
"organizations": [{"id": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"selfServeEnabled": true,
"membership": {"name": "string",
"mayBorrow": true,
"mayUseKiosk": true,
"mayBorrowMax": 0,
"expiration": "string",
"isExpired": true
}
}
]
}

Organization info.

Returns information about the organization for which we support self-checkout or self-registration. See also self-checkout API.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
451

Content type

application/json

{"id": "string",
"shortName": "string",
"apiUrl": "string",
"name": "string",
"logo": "string",
"hours": [{"closed": true,
"openTime": "10:00:00.000",
"closeTime": "19:00:00.000"
}
],
"address": {"street1": "string",
"street2": "string",
"city": "string",
"principalSubdivision": "VT",
"country": "CAN",
"phone": "string"
},
"playSounds": true,
"hideMoney": true,
"enableKioskMode": true,
"selfServeEnabled": true,
"allowKioskScanLogin": true,
"allowKioskFormLogin": true,
"logoutTimeout": 5,
"skipKioskCheckinConfirmation": true,
"skipKioskCheckoutConfirmation": true,
"skipKioskLogoutConfirmation": true,
"kioskWelcomeText": "<p>Welcome to our Kiosk. Log in or scan your key fob to get started</p>",
"kioskHomeText": "string",
"kioskCheckInText": "string",
"kioskCheckOutText": "string",
"kioskPostCheckInText": "<p>Please be sure to lock up when you leave.</p>",
"kioskPostCheckOutText": "string",
"kioskScanLoginErrorText": "string",
"kioskFormLoginErrorText": "If you are having trouble logging in, please call Jane at (888) 555-1212",
"locale": "fr-CA",
"currencyCode": "CAD",
"useTwoPhaseCommitOnKiosk": false,
"projectsSupported": true,
"email": "string",
"renewMembershipUrl": "string"
}

List of supported languages/locales

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
451

Content type

application/json

[{"code": "fr",
"name": "French",
"native": "Français",
"isDefault": true
}
]

Available statuses

List of statuses available for this organization

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
451

Content type

application/json

[{"id": 5,
"name": "In maintenance"
}
]

A list of the locations for this organization.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
451

Content type

application/json

[{"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
]

User

Operations available to registered users who are logged in

Log the user out of the system.

Responses

Log the user out of the system. Deprecated

Responses

Retrieve a list of items or search for specific ones.

query Parameters

q	string A word, a few words, or parts of words to search on.
location	number Id of the location. This will restrict the items returned to the requested location and its sublocations.
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 1 .. 200 ] Default: 20 The numbers of items to return.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

[{"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
}
]

Return the details for a single item.

path Parameters

id

required

number

The unique identifier for the item.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

[{"id": 444,
"itemId": "DR002",
"name": "Hammer",
"description": "string",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"fullImage": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/big-image.jpg",
"manufacturer": "Panasonic",
"model": "SD-ZB2502",
"location": "string",
"loanLength": 0,
"amountDisplay": "1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"availableForCheckout": true,
"maxReturnDate": "string",
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
]
}
]

Return a single category.

path Parameters

id

required

number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}

List or search for items by category.

path Parameters

id

required

number

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 1 .. 200 ] Default: 20 The numbers of items to return.
q	string A word, a few words, or parts of words to search on.
location	number Id of the location. This will restrict the items returned to the requested location and its sublocations.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

[{"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
}
]

List a user's approved reservations (defaults to reservations for today).

query Parameters

includeFulfilled

string

Default: "N"

Use "Y" to include fulfilled reservations; anything else is taken to mean "do not include fulfilled".

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

[{"id": 413,
"startDate": "string",
"endDate": "string",
"itemCount": 0,
"fulfilled": true
}
]

Get the details of one reservation.

path Parameters

reservation-id

required

number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

{"id": 413,
"startDate": "2018-11-01T00:00:00.000Z",
"endDate": "2018-11-15T00:00:00.000Z",
"items": [{"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
}
]
}

Remove an item from the reservation.

Remove an item from the reservation. This is useful to make sure the reservation will be flagged as complete once a checkout with all the items on the reservation is processed. NOTE that you may not remove the last item on a reservation.

path Parameters

reservation-id required	number
item-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/reservations/${reservation-id}/items/${item-id}

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/reservations/${reservation-id}/items/${item-id}

Test

https://demo.test.myturn.com/library/api/v1.1/reservations/${reservation-id}/items/${item-id}

Production

https://demo.myturn.com/library/api/v1.1/reservations/${reservation-id}/items/${item-id}

Response samples

200
404
422
451

Content type

application/json

{"id": 413,
"startDate": "2018-11-01T00:00:00.000Z",
"endDate": "2018-11-15T00:00:00.000Z",
"items": [{"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
}
]
}

List a user's projects

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

[{"id": 156,
"name": "Energy audit at 123 Sesame Street"
}
]

List the carts for a user.

List the carts for a user. In most cases, there is only one cart to return.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

[{"id": 45,
"link": "https://demo.myturn.com/api/selfcheckout/cart/3",
"amount": 0
}
]

Create a new cart for the user.

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

451

Content type

application/json

Example

missing-agreement

{"code": "Agreement Signature Required",
"message": "There are one or more agreements you must sign before you can continue.",
"extraActionRequiredUrl": "https://someorg.myturn.com/library/agreementSignature/list"
}

Return a specific cart.

Return a single cart by cartId.

path Parameters

cart-id

required

number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Delete a specific cart.

Delete cart and cancel the current transaction.

path Parameters

cart-id

required

number

Responses

Response samples

200
404
451

Content type

application/json

"OK"

Start the return for a specific loan.

Start the return process for one loan. This will not be completed until the cart is committed (see /cart/{cart-id}/commit).

path Parameters

cart-id required	number
loan-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: multipart/form-data

new-status

number

New status to set on the item being returned. Status id must be valid.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Remove a specific loan previously marked for return.

path Parameters

cart-id required	number
loan-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Confirm that the user has returned the item, usually in a secured location.

The item has been returned, and should the cart be interrupted, this SHOULD be recorded has having been returned anyway.

path Parameters

cart-id required	number
loan-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}/commit

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}/commit

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}/commit

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkins/{loan-id}/commit

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Add an item to the cart by Item ID to mark it for check out.

Add an item to the cart based on the unique Item ID (barcode/RFID) to mark the user wants to check it out. It will not be checked out to the user until the cart is converted (completed/submitted).

path Parameters

cart-id

required

number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/x-www-form-urlencoded
required

item-id required	string
reservation-id	number The id of a reservation. Normally, this is the reservation from which the item was pulled, but it will take the due date based on the reservation even if the item wasn't on the reservation. If the reservation has passed, it will be ignored.
due-date	string The due date in ISO format, without time (YYYY-MM-DD). One of due-date or reservation-id must be passed.
project-id	number The id of the project to associate with this check out. Required to check out if the organization requires projects to check out. Use id 0 to unset the project for this check out.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts

Response samples

200
403
404
422
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Set or change details about the check out.

After an item is added to a cart for check out you can update information about it. This is currently limited to the due date and project.

path Parameters

cart-id required	number
checkout-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Request Body schema: application/x-www-form-urlencoded

due-date	string <ISO date format, without time (YYYY-MM-DD).>
project-id	number The id of the project to associate with this check out. Required to check out if the organization requires projects to check out. Use id 0 to unset the project for this check out.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Do not check out an item.

Do not check out an item and remove the item from the cart.

path Parameters

cart-id required	number
checkout-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Confirm that the item has been removed, usually from a secured space.

path Parameters

cart-id required	number
checkout-id required	number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}/commit

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}/commit

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}/commit

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/checkouts/{checkout-id}/commit

Response samples

200
404
451

Content type

application/json

{"id": 43,
"amount": 0,
"amountPayable": 0,
"displayAmountPayable": "string",
"outstandingLoans": [{"id": 0,
"returning": true,
"checkoutDate": "2017-09-01T18:32:43.844Z",
"dueDate": "2017-09-16T03:59:00.000Z",
"lateFees": 0,
"discountedLateFees": 0,
"lateFeeRate": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"lateFeeDays": 0,
"committed": true,
"newStatus": {"id": 5,
"name": "In maintenance"
}
}
],
"checkouts": [{"id": 0,
"item": {"id": 999,
"itemId": "barcode-1234",
"name": "Hammer",
"thumbnail": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg",
"location": "string",
"locationCode": "string",
"loanLength": 0,
"grouping": "string",
"availableForCheckout": true,
"maxReturnDate": "string",
"amountDisplay": "$1.21 per day",
"amount": 1.21,
"discountedAmountDisplay": "1.21 per day",
"discountedAmount": 1.21,
"amountPeriod": {"code": "string",
"display": "string"
},
"categories": [{"id": 0,
"name": "string",
"image": "https://myturn-prod-images-in.s3.amazonaws.com/path/to/image.jpg"
}
],
"statuses": [{"id": 5,
"name": "In maintenance"
}
],
"homeLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
},
"currentLocation": {"id": 43,
"name": "4th Floor",
"path": ["Building B",
"4th Floor",
"Room 405"
]
}
},
"availableDueDates": ["string"
],
"dueDate": "string",
"amount": 0,
"discountedAmount": 0,
"committed": true
}
],
"membershipChange": { },
"otherFees": { },
"payments": [{ }
],
"discounts": [{"name": "string",
"amount": 3,
"percentage": 0,
"isLateFee": true,
"isCheckout": true
}
],
"canCheckoutItems": true,
"projectRequired": true
}

Process the cart and complete all pending transactions.

path Parameters

cart-id

required

number

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Local deploy (generic)

https://demo.localhost.myturn.com:8443/library/api/v1.1/self-checkout/carts/{cart-id}/convert

Local deploy (Nancy)

https://demo.luisa.myturn.com:8441/library/api/v1.1/self-checkout/carts/{cart-id}/convert

Test

https://demo.test.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/convert

Production

https://demo.myturn.com/library/api/v1.1/self-checkout/carts/{cart-id}/convert

Response samples

200
403
404
422
451

Content type

application/json

"OK"

Testing

List of supported languages/locales

header Parameters

Accept-Language

string

Locale requested, per RFC 3282. However, myTurn will only use the language portion of the locale requested, and apply the organization's country. You are welcome to send only the two letter language code.

Responses

Response samples

200
451

Content type

application/json

[{"code": "fr",
"name": "French",
"native": "Français",
"isDefault": true
}
]

Self Service (1.1-oas3)

Public

Log in to get initial access token.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json

Responses

Request samples

Response samples

Organization info.

header Parameters

Responses

Response samples

List of supported languages/locales

header Parameters

Responses

Response samples

Available statuses

header Parameters

Responses

Response samples

A list of the locations for this organization.

header Parameters

Responses

Response samples

User

Log the user out of the system.

Responses

Log the user out of the system. Deprecated

Responses

Retrieve a list of items or search for specific ones.

query Parameters

header Parameters

Responses

Response samples

Return the details for a single item.

path Parameters

header Parameters

Responses

Response samples

Retrieve a list of item categories.

header Parameters

Responses

Response samples

Return a single category.

path Parameters

header Parameters

Responses

Response samples

List or search for items by category.

path Parameters

query Parameters

header Parameters

Responses

Response samples

List a user's approved reservations (defaults to reservations for today).

query Parameters

header Parameters

Responses

Response samples

Get the details of one reservation.

path Parameters

header Parameters

Responses

Response samples

Remove an item from the reservation.

path Parameters

header Parameters

Responses

Response samples

List a user's projects

header Parameters

Responses

Response samples

List the carts for a user.

header Parameters

Responses

Response samples

Create a new cart for the user.

header Parameters

Responses

Response samples

Request Body schema:
application/json

Request Body schema: application/x-www-form-urlencoded
required