Jump to

• Request
• Response

Retrieve Party ID, Customer Number, and Party Name for LOV Component

get

/dmparty-service/parties/lov

This endpoint is used to fetch Party ID, Customer Number, and Party Name for LOV Component.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerNbr(optional): string
  Customer Number.
• partyName(optional): string
  Party Name.

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

PartyId, Party Number and Party Name for Lov Component.

Body ()

Root Schema : DmPartyLovCollection

Type: object

Collection of PartyLovDTO.

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object DmPartyLovDTO
  DmPartyLovDTO model

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

Nested Schema : DmPartyLovDTO

Type: object

DmPartyLovDTO model

Show Source

• customerNbr(optional): string
  customerNbr of the DmParty
• partyId(optional): string
  partyId of the DmParty
• partyName(optional): string
  partyName of the DmParty

{
    "description":"DmPartyLovDTO model",
    "type":"object",
    "properties":{
        "partyId":{
            "description":"partyId of the DmParty",
            "type":"string"
        },
        "customerNbr":{
            "description":"customerNbr of the DmParty",
            "type":"string"
        },
        "partyName":{
            "description":"partyName of the DmParty",
            "type":"string"
        }
    }
}

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