Skip to content
Wink

Name check

GET
/api/managing-entity/name
curl --request GET \
  --url 'https://api.wink.travel/api/managing-entity/name?geoNameId=1609350&name=The%20Siam%20Residences&managingEntityIdentifier=d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69' \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Verifies that the name is unique.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
geoNameId
string

GeoNames ID of the city to scope the uniqueness check to.

Example 

1609350
name
required
string

Managing entity name to check for uniqueness.

Example 

The Siam Residences
managingEntityIdentifier
string

UUID of an existing managing entity to exclude from the uniqueness check (so the entity can keep its own name).

Example 

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

Section titled “Header Parameters”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “Responses”

200

Section titled “200”

Result indicating whether the name is unique within the given city context.

Media typeapplication/json

Result indicating whether a value is unique within the platform

object
unique
required

True if the checked value is unique; false if it already exists

boolean

Example 

{
  "unique": true
}

400

Section titled “400”

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

401

Section titled “401”

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

403

Section titled “403”

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

404

Section titled “404”

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

405

Section titled “405”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

409

Section titled “409”

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

415

Section titled “415”

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

500

Section titled “500”

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

503

Section titled “503”

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri

Example generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}