Jump to

• Request
• Response

Create a state

post

/fscmRestApi/resources/11.13.18.05/publicSectorStates

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 state.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• LocalityGnisId: integer (int64)
  Title: GNIS Identifier

  The locality ID of the state as defined in the Geographic Names Information System of the United States Geological Survey.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• StateCode: string
  Title: Code

  Maximum Length: 2

  The unique state code.
• StateCodeISO: string
  Title: ISO Code

  Maximum Length: 6

  The code for the state according to the ISO 3166-2 standard.
• StateName: string
  Title: State Name

  Maximum Length: 60

  The state name.
• StateSubdivisionCode: string
  Title: Subdivision 2 ISO Code

  Maximum Length: 6

  The code for the state according to the ISO 3166-2 iv2 Subdivision 2 standard.
• SubdivisionType: integer (int32)
  Title: Type

  The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.

{
    "type":"object",
    "properties":{
        "StateCodeISO":{
            "title":"ISO Code",
            "maxLength":"6",
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 standard.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            }
        },
        "StateSubdivisionCode":{
            "title":"Subdivision 2 ISO Code",
            "maxLength":"6",
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 iv2 Subdivision 2 standard.",
            "nullable":true
        },
        "StateName":{
            "title":"State Name",
            "maxLength":"60",
            "type":"string",
            "description":"The state name.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "StateCode":{
            "title":"Code",
            "maxLength":"2",
            "type":"string",
            "description":"The unique state code.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "default":false
        },
        "SubdivisionType":{
            "title":"Type",
            "type":"integer",
            "description":"The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"2"
            }
        },
        "CountryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique identifier for the country associated with the state.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptRest":"countries"
            }
        },
        "LocalityGnisId":{
            "title":"GNIS Identifier",
            "type":"integer",
            "description":"The locality ID of the state as defined in the Geographic Names Information System of the United States Geological Survey.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        }
    }
}

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 : publicSectorStates-item-response

Type: object

Show Source

• CountryCode: string
  Maximum Length: 3

  The unique identifier for the country associated with the state.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the state was created.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  The link relations associated with the resource instance.
• LocalityGnisId: integer (int64)
  Title: GNIS Identifier

  The locality ID of the state as defined in the Geographic Names Information System of the United States Geological Survey.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• StateCode: string
  Title: Code

  Maximum Length: 2

  The unique state code.
• StateCodeISO: string
  Title: ISO Code

  Maximum Length: 6

  The code for the state according to the ISO 3166-2 standard.
• StateName: string
  Title: State Name

  Maximum Length: 60

  The state name.
• StateSubdivisionCode: string
  Title: Subdivision 2 ISO Code

  Maximum Length: 6

  The code for the state according to the ISO 3166-2 iv2 Subdivision 2 standard.
• SubdivisionType: integer (int32)
  Title: Type

  The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the state was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCodeISO":{
            "title":"ISO Code",
            "maxLength":"6",
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 standard.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "StateSubdivisionCode":{
            "title":"Subdivision 2 ISO Code",
            "maxLength":"6",
            "type":"string",
            "description":"The code for the state according to the ISO 3166-2 iv2 Subdivision 2 standard.",
            "nullable":true,
            "x-queryable":true
        },
        "StateName":{
            "title":"State Name",
            "maxLength":"60",
            "type":"string",
            "description":"The state name.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "StateCode":{
            "title":"Code",
            "maxLength":"2",
            "type":"string",
            "description":"The unique state code.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubdivisionType":{
            "title":"Type",
            "type":"integer",
            "description":"The type of state based on definitions created by the ISO organization. Possible values can be State, Province, Emirate, etc.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique identifier for the country associated with the state.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptRest":"countries"
            },
            "x-queryable":true
        },
        "LocalityGnisId":{
            "title":"GNIS Identifier",
            "type":"integer",
            "description":"The locality ID of the state as defined in the Geographic Names Information System of the United States Geological Survey.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the state 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