Skip to content
/
Update EDICodeMap

Update EDICodeMap

Request

Updates a specific EDICodeMap.

Security
apiKeyAuth and bearerAuth
Path
eDICodeMapKeyinteger, (int32)required

EDICodeMap Key

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
ediCodeMap_Keyinteger, (int32)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.

destination_Valuestring, [ 1 .. 64 ] charactersrequired

Value that is assigned at the destination when the source value is encountered

directionstring, [ 1 .. 3 ] charactersrequired

Specifies the direction of the EDI transfer - import or export

effective_Datestring or null, (date-time)

Optional date when the EDI code map condition becomes effective

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

map_Typestring, [ 1 .. 16 ] charactersrequired

Type of map that is being used for the EDI transfer

map_Variable1string or null, <= 128 characters

Variable associated with the EDI code map

map_Variable2string or null, <= 128 characters

Variable associated with the EDI code map

map_Variable3string or null, <= 128 characters

Variable associated with the EDI code map

map_Variable4string or null, <= 128 characters

Variable associated with the EDI code map

map_Variable5string or null, <= 128 characters

Variable associated with the EDI code map

source_Valuestring, [ 1 .. 64 ] charactersrequired

Value specified by the source that needs to be mapped

term_Datestring or null, (date-time)

Optional date when the EDI code map condition terminates

trading_Partner_Keyinteger or null, (int32)

Kev value that identifies the EDI trading partner or vendor

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/edi-code-mapping/{eDICodeMapKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "ediCodeMap_Key": 0,
    "destination_Value": "string",
    "direction": "str",
    "effective_Date": "2019-08-24T14:15:22Z",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "map_Type": "string",
    "map_Variable1": "string",
    "map_Variable2": "string",
    "map_Variable3": "string",
    "map_Variable4": "string",
    "map_Variable5": "string",
    "source_Value": "string",
    "term_Date": "2019-08-24T14:15:22Z",
    "trading_Partner_Key": 0,
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}