Skip to content
Docs
Select language:English

/api/v1/locations/{locationId}/own-codes (PUT)

PUT
/api/v1/locations/{locationId}/own-codes
curl --request PUT \
  --url https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/own-codes \
  --header 'Content-Type: application/json' \
  --data '{ "numbering": { "enabled": true, "prefix": "example", "pad": 1 }, "rule": { "pattern": "example", "message": "example", "example": "example" } }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
numbering
required
object
enabled
required
boolean
prefix
required
string
<= 40 characters
pad
required
integer
>= 1 <= 8
rule
required
Any of:
object
pattern
required
string
>= 1 characters <= 200 characters
message
required
string
>= 1 characters <= 200 characters
example
required
string
>= 1 characters <= 100 characters
Examplegenerated
{
  "numbering": {
    "enabled": true,
    "prefix": "example",
    "pad": 1
  },
  "rule": {
    "pattern": "example",
    "message": "example",
    "example": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
numbering
required
object
enabled
required
boolean
prefix
required
string
pad
required
integer
>= -9007199254740991 <= 9007199254740991
next
required
string
rule
required
Any of:
object
pattern
required
string
message
required
string
example
required
string
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "numbering": {
    "enabled": true,
    "prefix": "example",
    "pad": 1,
    "next": "example"
  },
  "rule": {
    "pattern": "example",
    "message": "example",
    "example": "example"
  },
  "rowVersion": 1
}