Jump to

• Request
• Response

Manage Clearances

post

/services/private/clearance/induction

The Clearance web service supports the ability to create, update, or delete a clearance from an external source. It is modeled on the Clearance Induction process.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: array

Show Source

• Array of: object ClearanceInductionRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ClearanceInductionRequest"
    }
}

Nested Schema : ClearanceInductionRequest

Type: object

Show Source

• action: string
• changeType: string
• changeValue: number
• clearance: integer (int64)
• clearanceGroup: integer (int64)
• clearanceGroupDesc: string
• diff: string
• effectiveDate: string (date)
• item: string
• location: integer (int64)
• locationType: string
• markdown: string
• newGroupBatch: integer (int64)
• reason: string
• roundingRule: string
• status: string
• updatedEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string"
        },
        "newGroupBatch":{
            "type":"integer",
            "format":"int64"
        },
        "clearanceGroup":{
            "type":"integer",
            "format":"int64"
        },
        "clearanceGroupDesc":{
            "type":"string"
        },
        "clearance":{
            "type":"integer",
            "format":"int64"
        },
        "markdown":{
            "type":"string"
        },
        "item":{
            "type":"string"
        },
        "diff":{
            "type":"string"
        },
        "locationType":{
            "type":"string"
        },
        "location":{
            "type":"integer",
            "format":"int64"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date"
        },
        "updatedEffectiveDate":{
            "type":"string",
            "format":"date"
        },
        "changeType":{
            "type":"string"
        },
        "changeValue":{
            "type":"number"
        },
        "roundingRule":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object ClearanceInductionRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ClearanceInductionRequest"
    }
}

Nested Schema : ClearanceInductionRequest

Type: object

Show Source

• action: string
• changeType: string
• changeValue: number
• clearance: integer (int64)
• clearanceGroup: integer (int64)
• clearanceGroupDesc: string
• diff: string
• effectiveDate: string (date)
• item: string
• location: integer (int64)
• locationType: string
• markdown: string
• newGroupBatch: integer (int64)
• reason: string
• roundingRule: string
• status: string
• updatedEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string"
        },
        "newGroupBatch":{
            "type":"integer",
            "format":"int64"
        },
        "clearanceGroup":{
            "type":"integer",
            "format":"int64"
        },
        "clearanceGroupDesc":{
            "type":"string"
        },
        "clearance":{
            "type":"integer",
            "format":"int64"
        },
        "markdown":{
            "type":"string"
        },
        "item":{
            "type":"string"
        },
        "diff":{
            "type":"string"
        },
        "locationType":{
            "type":"string"
        },
        "location":{
            "type":"integer",
            "format":"int64"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date"
        },
        "updatedEffectiveDate":{
            "type":"string",
            "format":"date"
        },
        "changeType":{
            "type":"string"
        },
        "changeValue":{
            "type":"number"
        },
        "roundingRule":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : ClearanceInductionResponse

Type: object

Show Source

• failedClearances: array array failedClearances
• hyperMediaContent: object object hyperMediaContent
• links: array array links
• statusMessage: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "SELF_LINK",
                    "NEXT_LINK",
                    "PREV_LINK",
                    "CUSTOM_LINK"
                ]
            }
        },
        "statusMessage":{
            "type":"string"
        },
        "failedClearances":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FailedClearance"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : failedClearances

Type: array

Show Source

• Array of: object FailedClearance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FailedClearance"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: string
  Allowed Values: [ "SELF_LINK", "NEXT_LINK", "PREV_LINK", "CUSTOM_LINK" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "SELF_LINK",
            "NEXT_LINK",
            "PREV_LINK",
            "CUSTOM_LINK"
        ]
    }
}

Nested Schema : FailedClearance

Type: object

Show Source

• clearance: integer (int64)
• diff: string
• effectiveDate: string (date)
• errorMsg: string
• item: string
• location: integer (int64)
• locationType: string

{
    "type":"object",
    "properties":{
        "clearance":{
            "type":"integer",
            "format":"int64"
        },
        "item":{
            "type":"string"
        },
        "diff":{
            "type":"string"
        },
        "locationType":{
            "type":"string"
        },
        "location":{
            "type":"integer",
            "format":"int64"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date"
        },
        "errorMsg":{
            "type":"string"
        }
    }
}

Back to Top