# List EDICodeMap

Lists all EDICodeMap

Endpoint: GET /edi-code-mapping
Version: v1
Security: apiKeyAuth, bearerAuth

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `bearerAuth` (unknown)
    http bearer JWT

## Query parameters:

  - `page` (integer)
    Page number. Pages start at 1; page 0 returns 500.

  - `pageSize` (integer)
    Items per page. Defaults to 100. The server sets no maximum; choose a size your client can process in one response.

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `data` (array)

  - `data.ediCodeMap_Key` (integer, required)
    Key value that identifies the EDI code map Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.destination_Value` (string, required)
    Value that is assigned at the destination when the source value is encountered

  - `data.direction` (string, required)
    Specifies the direction of the EDI transfer - import or export

  - `data.effective_Date` (string)
    Optional date when the EDI code map condition becomes effective

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string)
    User that first added the record to the system

  - `data.map_Type` (string, required)
    Type of map that is being used for the EDI transfer

  - `data.map_Variable1` (string)
    Variable associated with the EDI code map

  - `data.map_Variable2` (string)
    Variable associated with the EDI code map

  - `data.map_Variable3` (string)
    Variable associated with the EDI code map

  - `data.map_Variable4` (string)
    Variable associated with the EDI code map

  - `data.map_Variable5` (string)
    Variable associated with the EDI code map

  - `data.source_Value` (string, required)
    Value specified by the source that needs to be mapped

  - `data.term_Date` (string)
    Optional date when the EDI code map condition terminates

  - `data.trading_Partner_Key` (integer)
    Kev value that identifies the EDI trading partner or vendor

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string)
    User that last updated the record in the system

  - `error` (object)

  - `error.detail` (string)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)

## Response 200 headers (application/json):

  - `X-Pagination` (string)
    Paging metadata as JSON: `TotalCount`, `TotalPages`, `CurrentPage`, `PageSize`. Pages start at 1.
    Example: {"TotalCount":250,"TotalPages":3,"CurrentPage":1,"PageSize":100}

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 403:

  - `403` (unknown)
    Forbidden. The x-api-key header is missing or not valid. The API gateway sends this response, not VBAPI, so the body is not the VBAPI envelope; see Errors and troubleshooting.

## Response 429:

  - `429` (unknown)
    Too many requests. The limit is 25 requests per second sustained, with bursts up to 50, per API key. Wait and retry with exponential backoff and jitter.