Jump to

• Request
• Response

Get Service Area Restriction

get

ss/oc-cnpolicy-configuration/v1/policydata/pcfam/servicearearestrictions/{serviceAreaRestrictionName}

Request

Path Parameters

• serviceAreaRestrictionName: string
  Service Area Restriction Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Resource fetched successfully

Body ()

Root Schema : ServiceAreaRestriction

Type: object

Title: ServiceAreaRestriction

Show Source

• areas(optional): array areas
• description(optional): string
• maxNumOfTAs(optional): number
• name: string
• restrictionType(optional): string
  Allowed Values: [ "ALLOWED_AREAS", "NOT_ALLOWED_AREAS" ]

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "areas":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceAreaRestrictionAreas"
            }
        },
        "description":{
            "type":"string"
        },
        "maxNumOfTAs":{
            "type":"number"
        },
        "name":{
            "type":"string"
        },
        "restrictionType":{
            "type":"string",
            "enum":[
                "ALLOWED_AREAS",
                "NOT_ALLOWED_AREAS"
            ]
        }
    },
    "title":"ServiceAreaRestriction"
}

Nested Schema : areas

Type: array

Show Source

• Array of: object ServiceAreaRestrictionAreas
  Title: ServiceAreaRestrictionAreas

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ServiceAreaRestrictionAreas"
    }
}

Nested Schema : ServiceAreaRestrictionAreas

Type: object

Title: ServiceAreaRestrictionAreas

Show Source

• areaCodes(optional): string
• tacs(optional): array tacs

{
    "type":"object",
    "properties":{
        "areaCodes":{
            "type":"string"
        },
        "tacs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"ServiceAreaRestrictionAreas"
}

Nested Schema : tacs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Service Unavailable

Back to Top