Jump to

• Request
• Response

Get Department Details for Department or Department Name

get

/services/private/Common/departmentSearch

This service is used to get departments matching the provided department IDs or names.

Request

Query Parameters

• pageNumber(required): integer(int32)
  Result page to retrieve

  Default Value: 1
• pageSize(required): integer(int32)
  Maximum number of records to retrieve per page

  Default Value: 25
• searchString(required): string
  search string for department Id or Name

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : pagedResultsRDO

Type: object

Show Source

• count: integer (int32)
• hasMore: boolean
• hyperMediaContent: object hyperMediaContent
• limit: integer (int32)
• links: array links
• results: array results
• totalRecordCount: integer (int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "totalRecordCount":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Record"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"pagedResultsRDO"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object Record

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Record"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Nested Schema : Record

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

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

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

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

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Back to Top