Jump to

• Request
• Response

Retrieves the external system details by branch code

get

/branch/externalSystemDetails/{branchCode}

This endpoint is used to get the external system details by branchCode.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• branchCode: string
  Branch Code

Query Parameters

• version: string
  version

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the externalSystem Details by branchCode.

Body ()

Root Schema : LmmTmBrnExternalSysDetailsCollection

Type: object

Collection of branch and external system details.

Show Source

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

{
    "description":"Collection of branch and external system details.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmBrnExternalSysDetailsDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmBrnExternalSysDetailsDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LmmTmBrnExternalSysDetailsDTO

Type: object

Show Source

• branchCode(optional): string
• externalSystemId(optional): string
• interfaceMasterId(optional): string
• messageType(optional): string
• methodName(optional): string
• networkType(optional): string

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":""
        },
        "externalSystemId":{
            "type":"string",
            "description":""
        },
        "methodName":{
            "type":"string",
            "description":""
        },
        "messageType":{
            "type":"string",
            "description":""
        },
        "networkType":{
            "type":"string",
            "description":""
        },
        "interfaceMasterId":{
            "type":"string",
            "description":""
        }
    }
}

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