CreateWorkplace

POST /orgs/:org_guid/workplaces

CreateWorkplace

Request

Path Parameters

org_guid uuidrequired

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired

ClientIdentifier

Example: 0257501b-44b0-4b9f-ab71-f96dd535560b

X-LP-Client-Type stringrequired

Possible values: [Unknown, App, WebApp, Service]

ClientType

Example: App

X-LP-Client-Name string

ClientName

Example: Swagger

X-LP-Client-OS-Name string

ClientOSName

Example: SwaggerDoc

X-LP-Client-OS-Version string

ClientOSVersion

Example: 1.0

X-LP-Client-Screen-Resolution string

ClientScreenResolution

Example: 1280x0900

X-LP-Client-Model string

ClientModel

Example: Chrome 75

X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired

Language

Example: en-US

application/json-patch+json
application/json
text/json
application/*+json

Body

number int32nullable

Possible values: >= 1 and <= 99999

number

name stringnullable

Possible values: <= 128 characters

name

workplace_type WorkplaceTypes (string)required

Possible values: [Unknown, Mobile, Stationary, Automat]

activated_at date-timenullable

activated_at

organization

object

guid uuid

guid

type_of string

type_of

extensions

WorkplaceExtensions

Расширения

nadex_soft_pos

object

turned_on boolean

turned_on

virtual_serial_number stringrequired

Possible values: >= 19 characters and <= 19 characters, Value must match regular expression ^[a-zA-Z0-9]*$

virtual_serial_number

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_smart_pos

object

emv_config stringnullable

Possible values: <= 10485760 characters

emv_config

tms_params

object

ip stringrequired

Possible values: non-empty and <= 64 characters

port int32required

Possible values: <= 99999

port

ca1 stringrequired

Possible values: non-empty and <= 4096 characters

ca1

ca2 stringrequired

Possible values: non-empty and <= 4096 characters

ca2

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepos_quick_payments

object

qr_registrar_guid stringrequired

Possible values: non-empty

qr_registrar_guid

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

Body

number int32nullable

Possible values: >= 1 and <= 99999

number

name stringnullable

Possible values: <= 128 characters

name

workplace_type WorkplaceTypes (string)required

Possible values: [Unknown, Mobile, Stationary, Automat]

activated_at date-timenullable

activated_at

organization

object

guid uuid

guid

type_of string

type_of

extensions

WorkplaceExtensions

Расширения

nadex_soft_pos

object

turned_on boolean

turned_on

virtual_serial_number stringrequired

Possible values: >= 19 characters and <= 19 characters, Value must match regular expression ^[a-zA-Z0-9]*$

virtual_serial_number

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_smart_pos

object

emv_config stringnullable

Possible values: <= 10485760 characters

emv_config

tms_params

object

ip stringrequired

Possible values: non-empty and <= 64 characters

port int32required

Possible values: <= 99999

port

ca1 stringrequired

Possible values: non-empty and <= 4096 characters

ca1

ca2 stringrequired

Possible values: non-empty and <= 4096 characters

ca2

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepos_quick_payments

object

qr_registrar_guid stringrequired

Possible values: non-empty

qr_registrar_guid

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

Body

number int32nullable

Possible values: >= 1 and <= 99999

number

name stringnullable

Possible values: <= 128 characters

name

workplace_type WorkplaceTypes (string)required

Possible values: [Unknown, Mobile, Stationary, Automat]

activated_at date-timenullable

activated_at

organization

object

guid uuid

guid

type_of string

type_of

extensions

WorkplaceExtensions

Расширения

nadex_soft_pos

object

turned_on boolean

turned_on

virtual_serial_number stringrequired

Possible values: >= 19 characters and <= 19 characters, Value must match regular expression ^[a-zA-Z0-9]*$

virtual_serial_number

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_smart_pos

object

emv_config stringnullable

Possible values: <= 10485760 characters

emv_config

tms_params

object

ip stringrequired

Possible values: non-empty and <= 64 characters

port int32required

Possible values: <= 99999

port

ca1 stringrequired

Possible values: non-empty and <= 4096 characters

ca1

ca2 stringrequired

Possible values: non-empty and <= 4096 characters

ca2

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepos_quick_payments

object

qr_registrar_guid stringrequired

Possible values: non-empty

qr_registrar_guid

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

Body

number int32nullable

Possible values: >= 1 and <= 99999

number

name stringnullable

Possible values: <= 128 characters

name

workplace_type WorkplaceTypes (string)required

Possible values: [Unknown, Mobile, Stationary, Automat]

activated_at date-timenullable

activated_at

organization

object

guid uuid

guid

type_of string

type_of

extensions

WorkplaceExtensions

Расширения

nadex_soft_pos

object

turned_on boolean

turned_on

virtual_serial_number stringrequired

Possible values: >= 19 characters and <= 19 characters, Value must match regular expression ^[a-zA-Z0-9]*$

virtual_serial_number

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_smart_pos

object

emv_config stringnullable

Possible values: <= 10485760 characters

emv_config

tms_params

object

ip stringrequired

Possible values: non-empty and <= 64 characters

port int32required

Possible values: <= 99999

port

ca1 stringrequired

Possible values: non-empty and <= 4096 characters

ca1

ca2 stringrequired

Possible values: non-empty and <= 4096 characters

ca2

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepos_quick_payments

object

qr_registrar_guid stringrequired

Possible values: non-empty

qr_registrar_guid

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

Responses

Created

application/json

Schema
Example (from schema)
Example

Schema

number int32nullable

Possible values: >= 1 and <= 99999

number

name stringnullable

Possible values: <= 128 characters

name

workplace_type WorkplaceTypes (string)required

Possible values: [Unknown, Mobile, Stationary, Automat]

activated_at date-timenullable

activated_at

organization

object

guid uuid

guid

type_of string

type_of

extensions

WorkplaceExtensions

Расширения

nadex_soft_pos

object

turned_on boolean

turned_on

virtual_serial_number stringrequired

Possible values: >= 19 characters and <= 19 characters, Value must match regular expression ^[a-zA-Z0-9]*$

virtual_serial_number

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_smart_pos

object

emv_config stringnullable

Possible values: <= 10485760 characters

emv_config

tms_params

object

ip stringrequired

Possible values: non-empty and <= 64 characters

port int32required

Possible values: <= 99999

port

ca1 stringrequired

Possible values: non-empty and <= 4096 characters

ca1

ca2 stringrequired

Possible values: non-empty and <= 4096 characters

ca2

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepos_quick_payments

object

qr_registrar_guid stringrequired

Possible values: non-empty

qr_registrar_guid

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

{
  "number": 0,
  "name": "string",
  "workplace_type": "Unknown",
  "activated_at": "2024-11-18T08:30:47.049Z",
  "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"
    },
    "lifepos_quick_payments": {
      "qr_registrar_guid": "string",
      "version": "string"
    }
  },
  "created_at": "2024-11-18T08:30:47.049Z",
  "updated_at": "2024-11-18T08:30:47.049Z",
  "deleted_at": "2024-11-18T08:30:47.049Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

{
  "workplace_type": "Stationary",
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "guid": "fe7c8555-1470-433a-9123-40376c78a942",
  "type_of": "Workplace"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

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 stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

CreateWorkplace

/orgs/:org_guid/workplaces

Request​

Path Parameters

Query Parameters

Header Parameters

Body

Body

Body

Body

Responses​

Request

Responses