Jump to

• Request
• Response

Create a locality

post

/fscmRestApi/resources/11.13.18.05/publicSectorLocalities

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CountryCode: string
  Maximum Length: 3

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

  The International Committee for Information Technology Standards code for the county.
• LocalityGnisId: integer (int64)
  The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
• LocalityIdType: 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: string
  Maximum Length: 60

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

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

{
    "type":"object",
    "properties":{
        "StateCodeISO":{
            "maxLength":"6",
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 standard.",
            "nullable":false
        },
        "LocalityName":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the geographic object, such as city or region.",
            "nullable":false
        },
        "CountryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique identifier for the country associated with the locality.",
            "nullable":false
        },
        "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).",
            "nullable":true
        },
        "LocalityGnisId":{
            "type":"integer",
            "description":"The locality ID defined in the Geographic Names Information System of the United States Geological Survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "CountyCodeIncits":{
            "maxLength":"5",
            "type":"string",
            "description":"The International Committee for Information Technology Standards code for the county.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorLocalities-item-response

Type: object

Show Source

• CountryCode: string
  Maximum Length: 3

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

  The International Committee for Information Technology Standards code for the county.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the locality was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the locality was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocalityGnisId: integer (int64)
  The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
• LocalityIdType: 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: string
  Maximum Length: 60

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

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the locality was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCodeISO":{
            "maxLength":"6",
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 standard.",
            "nullable":false,
            "x-queryable":true
        },
        "LocalityName":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the geographic object, such as city or region.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique identifier for the country associated with the locality.",
            "nullable":false,
            "x-queryable":true
        },
        "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).",
            "nullable":true,
            "x-queryable":true
        },
        "LocalityGnisId":{
            "type":"integer",
            "description":"The locality ID defined in the Geographic Names Information System of the United States Geological Survey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "CountyCodeIncits":{
            "maxLength":"5",
            "type":"string",
            "description":"The International Committee for Information Technology Standards code for the county.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the locality was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top