API Reference

API Error Reference

Overview

Encompass Partner Connect uses conventional HTTP response codes to indicate the success or failure of an API request. Documented below are success, client error, and server error status codes used by the platform. Look here for an extensive reference of HTTP response codes.

I. Commonly Used Success Responses:

Status CodeDescription
200 OkThe request has succeeded.
201 CreatedThe request has succeeded and created a new resource.
202 AcceptedThe request has been accepted but not yet acted upon - usually to acknowledge acceptance of an asynchronous task.
204 No ContentThere is no content to respond with for this request, but the headers may be useful.

II. Commonly Used Client Error Responses:

Status CodeDescription
400 Bad RequestThe server could not understand the request due to invalid syntax.
401 UnauthorizedThe client must correctly authenticate itself to get the requested response.
403 ForbiddenThe client is authenticated but not authorized to access the requested content.
404 ForbiddenThe server can not find the requested resource.
405 Method Not AllowedThe request method is known by the server but has been disabled and cannot be used.
409 ConflictThe request conflicts with the current state of the server.
415 Unsupported Media TypeThe media format of the requested data is not supported by the server, so the server is rejecting the request.

III. Commonly Used Server Error Responses:

Status CodeDescription
500 Internal Server ErrorThe server has encountered a situation it doesn't know how to handle.
502 Bad GatewayThe server, while working as a gateway, got an invalid response.
503 Service UnavailableThe server is not ready to handle the request.
504 Gateway TimeoutThe server was acting as a gateway and couldn't get a response in time.

Note: 500, 502, 503, and 504 status codes indicate system exceptions and are very rarely thrown by the platform (refer to the API Service Level Agreement). If any of these status codes consistently occur for your environment, please contact EPC Support.


Error Messages

Most error HTTP statuses thrown by the API will be accompanied with an error message in the response body. Error messages follow the standard structure illustrated below:

[
  {
    "code": "EPC-1015",
    "description": "Product name is required",
    "type": "system",
    "fieldId": "name",
    "resourceId": "PRODUCT"
  }
]
AttributeDescription
codeUnique code for the error
descriptionHuman-friendly description for the error
typeError type. Currently, all errors are system errors
fieldIdResource field related to the error
resourceIdResource related to the error. It can be PRODUCT, ORIGIN, or TRANSACTION

Below is an index of the errors you may encounter when interacting with the API, and their error code and description.

API Error Codes and Descriptions

Error CodeDescription
EPC-1001Field is required
EPC-1002Parameter {0} is required
EPC-1003Start index should be a positive integer
EPC-1004Limit should be a positive integer and within range 1 and {0}
EPC-1005Start date {0} should be in ISO date format and less than current date
EPC-1006Start date {0} should be before end date {1}
EPC-1007End date {0} should be in ISO date format and less than current date
EPC-1010Unauthorized
EPC-1011Forbidden
EPC-1016Partner integration url is required
EPC-1017Partner integration type is required
EPC-1020Request type is required for request and response entitlements
EPC-1021Transaction entitlement is required
EPC-1031PLM format is required
EPC-1033Credential is required
EPC-1035Response status is required
EPC-1036Event text is required
EPC-1037Event type is required
EPC-1039Resource id required
EPC-1040Resource name does not end with correct extension
EPC-1041Invalid resource name
EPC-1042Resource name is required
EPC-1043Resource id {0} exists more than once in the {1}
EPC-1044Resource id {0} already exists on the transaction
EPC-1053Product listing name is required
EPC-1056Product already exists for partner id {0} and product name {1}
EPC-1057At least one request type is required for a product
EPC-1058Request type cannot be empty
EPC-1059Duplicate request types are not allowed
EPC-1065Data entitlement request type does not exist in product
EPC-1066Request type with existing data entitlements cannot be removed
EPC-1067Duplicate request type within data entitlements
EPC-1068Duplicate request type within the same data entitlement
EPC-1069{0} data entitlement field is required
EPC-1070Partner webhook information is required
EPC-1071Partner webhook url is required
EPC-1072Webhook events are required
EPC-1073Webhook event type is invalid
EPC-1074Webhook resource name is required
EPC-1075Webhook resource name is invalid
EPC-1076Name is readonly
EPC-1077Product not found for partner id {0} and product name {1}
EPC-1078{0} is a readonly attribute
EPC-1079Unauthorized to access product details
EPC-1080Partner webhook url is required
EPC-1081Resource events for required for webhook subscription
EPC-1082Resource name associated with the webhook subscription is required
EPC-1083Webhook subscription has duplicate resource name
EPC-1205Error creating product
EPC-1206Error updating product
EPC-1207Invalid product content
EPC-1208Product search requires partner id, product name or tag key/tag value
EPC-1209Partner id is readonly
EPC-1210Integration type is readonly
EPC-1211required properties do not exist
EPC-1212Invalid JsonPath(s) {0}
EPC-1213Data entitlement cannot have empty jsonpath
EPC-1214Invalid tenant pattern in allow or deny
EPC-1329Resource name required
EPC-1330At least one resource is required
EPC-1331Mime type is either missing or invalid
EPC-1332File extension is required
EPC-1333Resource id {0} does not exist on {1}
EPC-1334Either loan or resource is required
EPC-1338Error is required for failed response status
EPC-1339Error code is required
EPC-1340Error description is required
EPC-1341Response status should be failed when an error is present
EPC-1342Invalid numeric value
EPC-1343Should be a number and greater than zero
EPC-1400Invalid or expired Partner Access Token