NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Update a gate location details by ID.

put

/spms/v1/configurations/gangwayGateLocations/{id}

This is to update a gate location details by ID

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Body ()

Root Schema : gateLocation

Type: object

Title: gateLocation

Show Source

• code(optional): string
  Example: G1
• enabledFlag(optional): boolean
  Example: true
• entity(optional): string
  Example: GWL
• name(optional): string
  Example: Gangway Deck 1

{
    "title":"gateLocation",
    "type":"object",
    "properties":{
        "entity":{
            "type":"string",
            "example":"GWL"
        },
        "name":{
            "type":"string",
            "example":"Gangway Deck 1"
        },
        "code":{
            "type":"string",
            "example":"G1"
        },
        "enabledFlag":{
            "type":"boolean",
            "example":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful update of a gate location

Body ()

Root Schema : gateLocations

Type: object

Title: gateLocations

Show Source

• code(optional): string
  Example: G1
• enabledFlag(optional): boolean
  Example: true
• entity(optional): string
  Example: GWL
• name(optional): string
  Example: Gangway Deck 1

{
    "title":"gateLocations",
    "type":"object",
    "properties":{
        "entity":{
            "type":"string",
            "example":"GWL"
        },
        "name":{
            "type":"string",
            "example":"Gangway Deck 1"
        },
        "code":{
            "type":"string",
            "example":"G1"
        },
        "enabledFlag":{
            "type":"boolean",
            "example":true
        }
    }
}

400 Response

Bad Request or Invalid Parameter sent in Request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

This API is not allowed for your current user role

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

Requested gate location Not Found

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

409 Response

You are trying to update this gate location with an existing gate location

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occured while trying to update this gate location

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

Back to Top