Jump to

• Request
• Response

Update a locality

patch

/fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorLocalitiesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- CountryCode, StateCodeISO, CountyCodeIncits and LocalityGnisId ---for the Localities resource and used to uniquely identify an instance of Localities. The client should not generate the hash key value. Instead, the client should query on the Localities collection resource with a filter on the primary key values in order to navigate to a specific instance of Localities.
  
  For example: publicSectorLocalities?q=CountryCode=<value1>;StateCodeISO=<value2>;CountyCodeIncits=<value3>;LocalityGnisId=<value4>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorLocalities-item

Type: object

Show Source

• CountryCode(optional): string
  Maximum Length: 3

  The unique identifier for the country associated with the locality.
• CountyCodeIncits(optional): string
  Maximum Length: 5

  The International Committee for Information Technology Standards code for the county.
• CreationDate(optional): string(date-time)
  The date and time that the locality was created.
• LastUpdateDate(optional): string(date-time)
  The date and time that the locality was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LocalityGnisId(optional): integer(int64)
  The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
• LocalityIdType(optional): string
  Maximum Length: 10

  An identifier that explains how the locality can be identified. For example, a locality can be identified through an address (LocalityIdType ADDRESS), or it can be identified through coordinates on a map (LocalityIdType GIS).
• LocalityName(optional): string
  Maximum Length: 60

  Name of the geographic object, such as city or region.
• StateCodeISO(optional): string
  Maximum Length: 6

  The code for the state according to the ISO 3166-2 standard.

{
    "properties":{
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the country associated with the locality."
        },
        "CountyCodeIncits":{
            "maxLength":5,
            "type":"string",
            "description":"The International Committee for Information Technology Standards code for the county."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the locality was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the locality was last updated."
        },
        "LocalityGnisId":{
            "format":"int64",
            "type":"integer",
            "description":"The locality ID defined in the Geographic Names Information System of the United States Geological Survey."
        },
        "LocalityIdType":{
            "maxLength":10,
            "type":"string",
            "description":"An identifier that explains how the locality can be identified. For example, a locality can be identified through an address (LocalityIdType ADDRESS), or it can be identified through coordinates on a map (LocalityIdType GIS)."
        },
        "LocalityName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the geographic object, such as city or region."
        },
        "StateCodeISO":{
            "maxLength":6,
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 standard."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorLocalities-item

Type: object

Show Source

• CountryCode(optional): string
  Maximum Length: 3

  The unique identifier for the country associated with the locality.
• CountyCodeIncits(optional): string
  Maximum Length: 5

  The International Committee for Information Technology Standards code for the county.
• CreationDate(optional): string(date-time)
  The date and time that the locality was created.
• LastUpdateDate(optional): string(date-time)
  The date and time that the locality was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LocalityGnisId(optional): integer(int64)
  The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
• LocalityIdType(optional): string
  Maximum Length: 10

  An identifier that explains how the locality can be identified. For example, a locality can be identified through an address (LocalityIdType ADDRESS), or it can be identified through coordinates on a map (LocalityIdType GIS).
• LocalityName(optional): string
  Maximum Length: 60

  Name of the geographic object, such as city or region.
• StateCodeISO(optional): string
  Maximum Length: 6

  The code for the state according to the ISO 3166-2 standard.

{
    "properties":{
        "CountryCode":{
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the country associated with the locality."
        },
        "CountyCodeIncits":{
            "maxLength":5,
            "type":"string",
            "description":"The International Committee for Information Technology Standards code for the county."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the locality was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the locality was last updated."
        },
        "LocalityGnisId":{
            "format":"int64",
            "type":"integer",
            "description":"The locality ID defined in the Geographic Names Information System of the United States Geological Survey."
        },
        "LocalityIdType":{
            "maxLength":10,
            "type":"string",
            "description":"An identifier that explains how the locality can be identified. For example, a locality can be identified through an address (LocalityIdType ADDRESS), or it can be identified through coordinates on a map (LocalityIdType GIS)."
        },
        "LocalityName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the geographic object, such as city or region."
        },
        "StateCodeISO":{
            "maxLength":6,
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 standard."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top