ListWorkplace
GET/orgs/:org_guid/workplaces
ListWorkplace
Request
Path Parameters
Query Parameters
Possible values: non-empty
and <= 64 characters
Поиск производится по полям: number, name, meta, metadata
Possible values: [created_at_asc
, created_at_desc
, updated_at_asc
, updated_at_desc
, number_asc
, number_desc
, name_asc
, name_desc
, workplace_type_asc
, workplace_type_desc
, activated_at_asc
, activated_at_desc
]
Possible values: [alive_only
, archived_only
, all
]
Possible values: [compact
, full
]
Header Parameters
Идентификатор клиента
Possible values: [Unknown
, App
, WebApp
, Service
]
Тип клиента
Имя клиента
ОС клиента
Версия ОС клиента
Разрешение экрана ОС клиента
Модель оборудования клиента
Организация по умолчанию
Поддерживаемые клиентом расширения моделей
Язык используемый для ответов
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
items
object[]
nullable
items
Possible values: >= 1
and <= 99999
number
Possible values: <= 128 characters
name
Possible values: [Unknown
, Mobile
, Stationary
, Automat
]
activated_at
organization
object
guid
type_of
extensions
WorkplaceExtensions
Расширения
nadex_soft_pos
object
turned_on
Possible values: >= 19 characters
and <= 19 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
virtual_serial_number
Possible values: non-empty
and <= 8 characters
version
lifepay_smart_pos
object
Possible values: <= 10485760 characters
emv_config
tms_params
object
Possible values: non-empty
and <= 64 characters
ip
Possible values: <= 99999
port
Possible values: non-empty
and <= 4096 characters
ca1
Possible values: non-empty
and <= 4096 characters
ca2
Possible values: non-empty
and <= 8 characters
version
created_at
updated_at
deleted_at
Possible values: <= 128 characters
meta
meta_data
object
nullable
meta_data
guid
type_of
next_page_token
page_number
pages_total
items_per_page
items_total
type_of
{
"items": [
{
"number": 0,
"name": "string",
"workplace_type": "Unknown",
"activated_at": "2024-10-23T06:47:41.877Z",
"organization": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "string"
},
"extensions": {
"nadex_soft_pos": {
"turned_on": true,
"virtual_serial_number": "string",
"version": "string"
},
"lifepay_smart_pos": {
"emv_config": "string",
"tms_params": {
"ip": "string",
"port": 0,
"ca1": "string",
"ca2": "string"
},
"version": "string"
}
},
"created_at": "2024-10-23T06:47:41.877Z",
"updated_at": "2024-10-23T06:47:41.877Z",
"deleted_at": "2024-10-23T06:47:41.877Z",
"meta": "string",
"meta_data": {},
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "string"
}
],
"next_page_token": "string",
"page_number": 0,
"pages_total": 0,
"items_per_page": 0,
"items_total": 0,
"type_of": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Client Error
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Server Error
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InternalServerError
, TooManyRequests
, RequestIsNotValid
, BadRequest
, NoPermissions
, Unauthorized
, NotFound
, ReferenceNotFound
, Duplicate
, NotUnique
, NotNullOrUnique
, NotAllowed
, NotAllowedForArchived
, TryLater
, OperationCannotBePerformed
, NotificationsAreOutOfService
, TrySendCodeLater
, UsernameIsAlreadyTaken
, PhoneIsNotFound
, PhoneIsNotFoundInOrganization
, PhoneIsAlreadyTaken
, InvalidConfirmationCode
, ConfirmationCodeWasCanceled
, ConfirmationCodeWasNotSend
, UsernameDoesNotExist
, WrongUsernameOrPassword
, WrongActivationCode
, TryActivateLater
, AliasIsNotFound
, AliasIsAlreadyTaken
, NotAllowedForOwner
, DealPositionHasInvalidQuantity
, CheckMarkingCodeMustBeDisabled
, LegalEntityCrptTokenNotSpecified
]
message
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}