Page tree
Skip to end of metadata
Go to start of metadata

Retrieve list of requestors prime customers and prime of prime customers

URL /prime-customers
HTTP Method GET
Version 1.0.6
Content

Response - 200

Body

Firm Message - FirmMessage

Field Name Type Values Usage Description
count Count Integer

ALWAYS

Number of firms returned

firms[] Firms FirmInfo

Firm Info - FirmMessage.firms[]

Field Name Type Values Usage Description
description Description String

ALWAYS

Firm description

gfid Firm ID String

ALWAYS

Firm identifier (firm short name)

institutionID Institution ID String

ALWAYS

Unique identifier of the institution the firm is part of

institutionName Institution Name String

ALWAYS

Full name of the institution

parent Parent String

ALWAYS

Parent firm of this firm

publicID Public ID String

ALWAYS

The id which the "public" knows this firm as

Response - 400

Body

Error Message - ErrorMessage

Field Name Type Values Usage Description
errors[] Errors Error

Error - ErrorMessage.errors[]

Field Name Type Values Usage Description
code Code String
  • 400
ALWAYS
message Message String

ALWAYS
referenceIndex Reference Index Integer

ALWAYS

Bad Request

Response - 401

Unauthorized

Response - 403

Body

Error Message - ErrorMessage

Field Name Type Values Usage Description
errors[] Errors Error

Error - ErrorMessage.errors[]

Field Name Type Values Usage Description
code Code String
  • 403
ALWAYS
message Message String

ALWAYS
referenceIndex Reference Index Integer

ALWAYS

Forbidden

Response - 404

Not Found

Response - 500

Internal Server Error

  • No labels