Jump to

• Request
• Response

Create, Update, or Delete States of a Country

post

/api/CXIPlatformService/{version}/CXIReferenceEntity/country/{id}/child/state

Create, update or delete one ore more State records of a Country.

Request

Path Parameters

• id(required): string
  Value of resource id field. Example: US (for admin entity 'country')
• version(required): string
  API version. Example: v1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match One Schema

Show Source

• object stateRequest

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/stateRequest"
        }
    ]
}

Nested Schema : stateRequest

Type: object

Show Source

• items(required): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "required":[
                    "operation",
                    "data"
                ],
                "type":"object",
                "properties":{
                    "data":{
                        "$ref":"#/components/schemas/state"
                    },
                    "operation":{
                        "type":"string",
                        "description":"The field specifies the mode of operation. Supported operations: create,update or delete"
                    }
                }
            },
            "x-cardinality":"1"
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "required":[
            "operation",
            "data"
        ],
        "type":"object",
        "properties":{
            "data":{
                "$ref":"#/components/schemas/state"
            },
            "operation":{
                "type":"string",
                "description":"The field specifies the mode of operation. Supported operations: create,update or delete"
            }
        }
    },
    "x-cardinality":"1"
}

Nested Schema : items

Type: object

Show Source

• data(required): object state
• operation(required): string
  The field specifies the mode of operation. Supported operations: create,update or delete

{
    "required":[
        "operation",
        "data"
    ],
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/components/schemas/state"
        },
        "operation":{
            "type":"string",
            "description":"The field specifies the mode of operation. Supported operations: create,update or delete"
        }
    }
}

Nested Schema : state

Type: object

Show Source

• cisValue(required): string
  CIS value for State code.
• faValue(required): string
  FA value for State code.
• id(required): string
  Id of the State record.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the State record."
        },
        "cisValue":{
            "type":"string",
            "description":"CIS value for State code."
        },
        "faValue":{
            "type":"string",
            "description":"FA value for State code."
        }
    },
    "required":[
        "id",
        "cisValue",
        "faValue"
    ]
}

Examples

Select an example state

Back to Top

Response

Supported Media Types

• application/json

200 Response

The resource was updated successfully.

Body ()

Root Schema : schema

Match One Schema

Show Source

• object state

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/state"
        }
    ]
}

Nested Schema : state

Type: object

Show Source

• cisValue(required): string
  CIS value for State code.
• faValue(required): string
  FA value for State code.
• id(required): string
  Id of the State record.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the State record."
        },
        "cisValue":{
            "type":"string",
            "description":"CIS value for State code."
        },
        "faValue":{
            "type":"string",
            "description":"FA value for State code."
        }
    },
    "required":[
        "id",
        "cisValue",
        "faValue"
    ]
}

Examples

Select an example state

204 Response

The resource was updated successfully, but a failure in returning the updated resource back

400 Response

An error is encountered due to an invalid request

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

500 Response

An internal server error is encountered, due to an unknown reason

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

Back to Top