Jump to

• Request
• Response

Send FPL incremental updates from the FDP to the OCSDM Server

post

/rest/{versionId}/telephonyFraud/FPLUpdate

Incremental FPL updates are sent from the Fraud Detection and Prevention (FDP) device to the OCSDM Server.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• versionId: string
  The versionId parameter is v1.2.

Header Parameters

• X-OCFM-EVENT-NUMBER(optional): string
  The file contents contain up to which event number.
• X-REGISTRATION-ID(optional): string
  The registration identifier is used to identify the event source by OCSDM.

Body ()

Incremental FPL updates are sent from the Fraud Detection and Prevention (FDP) device to the OCSDM Server

Root Schema : fplUpdates

Type: object

Show Source

• addList(optional): object EntriesList
• deleteList(optional): object EntriesList
• editList(optional): object EntriesList

{
    "properties":{
        "addList":{
            "$ref":"#/definitions/EntriesList",
            "xml":{
                "name":"ADD_LIST"
            }
        },
        "deleteList":{
            "$ref":"#/definitions/EntriesList",
            "xml":{
                "name":"DELETE_LIST"
            }
        },
        "editList":{
            "$ref":"#/definitions/EntriesList",
            "xml":{
                "name":"EDIT_LIST"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"fplUpdates"
    }
}

Nested Schema : EntriesList

Type: object

Show Source

• blacklist(optional): array blacklist
• ratelimit(optional): array ratelimit
• redirect(optional): array redirect
• whitelist(optional): array whitelist

{
    "properties":{
        "blacklist":{
            "items":{
                "$ref":"#/definitions/FPLEntry",
                "xml":{
                    "name":"entryList"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "ratelimit":{
            "items":{
                "$ref":"#/definitions/FPLEntry",
                "xml":{
                    "name":"entryList"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "redirect":{
            "items":{
                "$ref":"#/definitions/FPLEntry",
                "xml":{
                    "name":"entryList"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "whitelist":{
            "items":{
                "$ref":"#/definitions/FPLEntry",
                "xml":{
                    "name":"entryList"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        }
    },
    "type":"object"
}

Nested Schema : blacklist

Type: array

Show Source

• Array of: object entryList

{
    "items":{
        "$ref":"#/definitions/FPLEntry",
        "xml":{
            "name":"entryList"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : ratelimit

Type: array

Show Source

• Array of: object entryList

{
    "items":{
        "$ref":"#/definitions/FPLEntry",
        "xml":{
            "name":"entryList"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : redirect

Type: array

Show Source

• Array of: object entryList

{
    "items":{
        "$ref":"#/definitions/FPLEntry",
        "xml":{
            "name":"entryList"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : whitelist

Type: array

Show Source

• Array of: object entryList

{
    "items":{
        "$ref":"#/definitions/FPLEntry",
        "xml":{
            "name":"entryList"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : entryList

Type: object

Show Source

• callsPerSecond(optional): string
• dataType(optional): string
  Allowed Values: [ "from_hostname", "from_phone_number", "from_username", "to_hostname", "to_phone_number", "to_username", "user_agent_header" ]
• datatype(optional): string
• id(optional): integer(int64)
• listType(optional): string
  Allowed Values: [ "call_blacklist", "call_whitelist", "call_rate_limit", "call_redirect" ]
• matchValue(optional): string
• maxActiveCalls(optional): string
• objectId(optional): string
• realm(optional): string
• redirectTarget(optional): string
• source(optional): string
• sourceId(optional): string
• target(optional): string
• timestamp(optional): string
• value(optional): string

{
    "properties":{
        "callsPerSecond":{
            "type":"string"
        },
        "dataType":{
            "enum":[
                "from_hostname",
                "from_phone_number",
                "from_username",
                "to_hostname",
                "to_phone_number",
                "to_username",
                "user_agent_header"
            ],
            "type":"string"
        },
        "datatype":{
            "type":"string"
        },
        "id":{
            "format":"int64",
            "type":"integer"
        },
        "listType":{
            "enum":[
                "call_blacklist",
                "call_whitelist",
                "call_rate_limit",
                "call_redirect"
            ],
            "type":"string"
        },
        "matchValue":{
            "type":"string"
        },
        "maxActiveCalls":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "realm":{
            "type":"string"
        },
        "redirectTarget":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "sourceId":{
            "type":"string"
        },
        "target":{
            "type":"string"
        },
        "timestamp":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"entryList"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

202 Response

The user request is accepted.

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top