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

Collection of lookup types.

Show Source

• data(optional): array data

{
    "description":"Collection of lookup types.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmLookupTypeDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmLookupTypeDTO

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

Nested Schema : DmTmLookupTypeDTO

Type: object

Show Source

• DmTmLookupCodeDTO(optional): array DmTmLookupCodeDTO
• lookupTypeCd(optional): string
  The lookup type code.
• lookupTypeDesc(optional): string
  The lookup type description.

{
    "type":"object",
    "properties":{
        "lookupTypeCd":{
            "description":"The lookup type code.",
            "type":"string"
        },
        "lookupTypeDesc":{
            "description":"The lookup type description.",
            "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
• id(optional): string
• lookupCd(optional): string
• lookupDesc(optional): string
• lookupTypeMasterId(optional): string
• seqNo(optional): integer
  Minimum Value: 0

  Maximum Value: 999
• subCodeOne(optional): string
• subCodeTwo(optional): string
• sysDefFlg(optional): boolean

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"",
            "type":"string"
        },
        "lookupDesc":{
            "description":"",
            "type":"string"
        },
        "seqNo":{
            "description":"",
            "type":"integer",
            "minimum":0,
            "maximum":999
        },
        "sysDefFlg":{
            "description":"",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"",
            "type":"string"
        },
        "enabledFlg":{
            "description":"",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":""
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":""
        }
    }
}

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