Jump to

• Request
• Response

Retrives the frequency by given ID

get

/frequency/{id}/unauthorized

This endpoint is used to get the unauthorized frequency identified by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Id of the user that needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the frequency based on given id.

Body ()

Root Schema : LmmTmFrequencyCollection

Type: object

Collection of frequency.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of frequency.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmFrequencyDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmFrequencyDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmmTmFrequencyDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmFrequencyDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "frequencyId":{
                    "type":"string",
                    "description":""
                },
                "description":{
                    "type":"string",
                    "description":""
                },
                "expression":{
                    "type":"string",
                    "description":""
                },
                "frequencyType":{
                    "type":"string",
                    "description":""
                },
                "frequencyCategory":{
                    "type":"string",
                    "description":""
                },
                "isEod":{
                    "type":"string",
                    "description":""
                },
                "isBod":{
                    "type":"string",
                    "description":""
                }
            },
            "required":[
                "id",
                "frequencyId",
                "expression"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmmTmFrequencyDTO-allOf[1]

Type: object

Show Source

• description(optional): string
• expression: string
• frequencyCategory(optional): string
• frequencyId: string
• frequencyType(optional): string
• isBod(optional): string
• isEod(optional): string

{
    "type":"object",
    "properties":{
        "frequencyId":{
            "type":"string",
            "description":""
        },
        "description":{
            "type":"string",
            "description":""
        },
        "expression":{
            "type":"string",
            "description":""
        },
        "frequencyType":{
            "type":"string",
            "description":""
        },
        "frequencyCategory":{
            "type":"string",
            "description":""
        },
        "isEod":{
            "type":"string",
            "description":""
        },
        "isBod":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "id",
        "frequencyId",
        "expression"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top