Jump to

• Request
• Response

Incremental update FPL list to the SDM server

post

/rest/{versionId}/telephonyFraud/FPLUpdate

The incremental updates are coming from FDP.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• versionId: string
  The versionId will be v1.2

Header Parameters

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

Body ()

It contains FPL incremental updates from FDP.

Root Schema : fplUpdates

Type: object

Show Source

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

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

Nested Schema : EntriesList

Type: object

Show Source

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

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

Nested Schema : entryList

Type: array

Show Source

• Array of: object entryList

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

Nested Schema : entryList

Type: array

Show Source

• Array of: object entryList

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

Nested Schema : entryList

Type: array

Show Source

• Array of: object entryList

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

Nested Schema : entryList

Type: array

Show Source

• Array of: object entryList

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

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

{
    "type":"object",
    "properties":{
        "objectId":{
            "type":"string"
        },
        "listType":{
            "type":"string",
            "enum":[
                "call_blacklist",
                "call_whitelist",
                "call_rate_limit",
                "call_redirect"
            ]
        },
        "dataType":{
            "type":"string",
            "enum":[
                "from_hostname",
                "from_phone_number",
                "from_username",
                "to_hostname",
                "to_phone_number",
                "to_username",
                "user_agent_header"
            ]
        },
        "matchValue":{
            "type":"string"
        },
        "realm":{
            "type":"string"
        },
        "callsPerSecond":{
            "type":"string"
        },
        "maxActiveCalls":{
            "type":"string"
        },
        "target":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "sourceId":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "datatype":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "timestamp":{
            "type":"string"
        },
        "redirectTarget":{
            "type":"string"
        }
    },
    "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