Jump to

• Request
• Response

Get All Valid Lookup Type

get

/obedm-common-services/lookuptype

This endpoint is used to Get all valid Lookup Type maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  Authorization Status that needs to be fetched.
• includecloseandunauth(optional): boolean
  Include close and Authorization need to be set to fetch summary record, default value is false.
• limit(optional): integer
  Limit is maximum number of records to be fetched.
• lookupTypeCd(optional): string
  LookupTypeCd that needs to be fetched.
• lookupTypeDesc(optional): string
  LookupTypeDesc that needs to be fetched.
• offset(optional): integer
  Offset is starting number of records to be fetched.
• recordStat(optional): string
  Record Status that needs to be fetched.
• sysDefFlg(optional): boolean
  System Definition Flag that needs to be fetched.

Header Parameters

• appId: string
  The ID of the Application.
• branchCode: string
  The branch code associated with the request.
• contentType(optional): string
  The Content Type of the request.
• tenantId(optional): string
  The ID of the Tenant.
• userId: string
  The ID of the User.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  Additional information of the Valid Lookup Type.

Body ()

Root Schema : DmTmLookupTypeCollection

Type: object

A collection of lookup type.

Show Source

• data(optional): array data
  An array of Lookup Type DTO objects.
• paging(optional): object PagingDto

{
    "description":"A collection of lookup type.",
    "type":"object",
    "properties":{
        "data":{
            "description":"An array of Lookup Type DTO objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmLookupTypeDTO"
            }
        },
        "paging":{
            "description":"An object containing paging information for the collection.",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

An array of Lookup Type DTO objects.

Show Source

• Array of: object DmTmLookupTypeDTO

{
    "description":"An array of Lookup Type DTO objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmLookupTypeDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer
  Total number of results available.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total number of results available."
        }
    }
}

Nested Schema : DmTmLookupTypeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmLookupTypeDTO-allOf[1]

{
    "type":"object",
    "required":[
        "lookupTypeCd",
        "lookupTypeDesc",
        "sysDefFlg"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "lookupTypeCd":{
                    "description":"The code representing the type of the lookup.",
                    "type":"string"
                },
                "lookupTypeDesc":{
                    "description":"A description of the type of the lookup.",
                    "type":"string"
                },
                "sysDefFlg":{
                    "description":"A flag indicating whether this lookup is a system default.",
                    "type":"boolean"
                },
                "sysDefStatus":{
                    "description":"The status of the system default lookup.",
                    "type":"string"
                },
                "DmTmLookupCodeDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmLookupCodeDTO"
                    }
                }
            }
        }
    ]
}

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 : DmTmLookupTypeDTO-allOf[1]

Type: object

Show Source

• DmTmLookupCodeDTO(optional): array DmTmLookupCodeDTO
• lookupTypeCd(optional): string
  The code representing the type of the lookup.
• lookupTypeDesc(optional): string
  A description of the type of the lookup.
• sysDefFlg(optional): boolean
  A flag indicating whether this lookup is a system default.
• sysDefStatus(optional): string
  The status of the system default lookup.

{
    "type":"object",
    "properties":{
        "lookupTypeCd":{
            "description":"The code representing the type of the lookup.",
            "type":"string"
        },
        "lookupTypeDesc":{
            "description":"A description of the type of the lookup.",
            "type":"string"
        },
        "sysDefFlg":{
            "description":"A flag indicating whether this lookup is a system default.",
            "type":"boolean"
        },
        "sysDefStatus":{
            "description":"The status of the system default lookup.",
            "type":"string"
        },
        "DmTmLookupCodeDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmLookupCodeDTO"
            }
        }
    }
}

Nested Schema : DmTmLookupCodeDTO

Type: array

Show Source

• Array of: object DmTmLookupCodeDTO

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

Nested Schema : DmTmLookupCodeDTO

Type: object

Show Source

• enabledFlg(optional): boolean
  The flag indicating if the lookup is enabled.
• id(optional): string
  The unique identifier for the lookup.
• lookupCd(optional): string
  The code for the lookup.
• lookupDesc(optional): string
  The description for the lookup.
• lookupTypeMasterId(optional): string
  The unique identifier for the lookup type of this lookup.
• seqNo(optional): integer
  Minimum Value: 0

  Maximum Value: 999

  The sequence number of the lookup.
• subCodeOne(optional): string
  The first sub-code for the lookup.
• subCodeTwo(optional): string
  The second sub-code for the lookup.
• sysDefFlg(optional): boolean
  The flag indicating if the lookup is system-defined.

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"The code for the lookup.",
            "type":"string"
        },
        "lookupDesc":{
            "description":"The description for the lookup.",
            "type":"string"
        },
        "seqNo":{
            "description":"The sequence number of the lookup.",
            "type":"integer",
            "minimum":0,
            "maximum":999
        },
        "sysDefFlg":{
            "description":"The flag indicating if the lookup is system-defined.",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"The first sub-code for the lookup.",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"The second sub-code for the lookup.",
            "type":"string"
        },
        "enabledFlg":{
            "description":"The flag indicating if the lookup is enabled.",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"The unique identifier for the lookup."
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":"The unique identifier for the lookup type of this lookup."
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top