Expandable Web API - Serial Number Cross Reference, Create

Serial Number Cross Reference, Create

Creates a new Serial Number Cross Reference using the supplied data and returns the details of the created Serial Number Cross Reference.

URL

/api/serial-number-cross-reference-create

Request Method

POST

Expandable Program

SN Cross Reference Editor (JCESX)

Required Fields

ASSEMBLY_ID
ASSEMBLY_SN
COMPONENT_ID
COMPONENT_SN
AUTH_TOKEN

Auth Token

This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.

Example Request JSON

{
  "ASSEMBLY_ID": "PUMP002",
  "ASSEMBLY_SN": "000342",
  "COMPONENT_ID": "MOTOR003",
  "COMPONENT_SN": "011698",
  "START_DATE": "2016-01-11",
  "ORDER_ID": "123456",
  "LINE_NUMBER": "1",
  "AUTH_TOKEN": ""
}

Full Request JSON

{
  "ASSEMBLY_ID": "",
  "ASSEMBLY_SN": "",
  "COMPONENT_ID": "",
  "COMPONENT_SN": "",
  "START_DATE": "",
  "END_DATE": "",
  "ORDER_ID": "",
  "LINE_NUMBER": "",
  "REFERENCE": "",
  "RA_REASON": "",
  "COMMENT": "",
  "AUTH_TOKEN": ""
}

Success Response

Returned HTTP status indicates success:

200/OK

Returned JSON contains the successfully created Serial Number Cross Reference:

{
  "ASSEMBLY_ID": "",
  "ASSEMBLY_DESC": "",
  "ASSEMBLY_SN": "",
  "ASSEMBLY_SN_STATUS": "",
  "COMPONENT_ID": "",
  "COMPONENT_DESC": "",
  "COMPONENT_SN": "",
  "COMPONENT_SN_STATUS": "",
  "START_DATE": "",
  "END_DATE": "",
  "ORDER_ID": "",
  "LINE_NUMBER": "",
  "REFERENCE": "",
  "RA_REASON": "",
  "COMMENT": "",
  "CREATED_BY": "",
  "DATE_CREATED": "",
  "MODIFIED_BY": "",
  "DATE_MODIFIED": "",
  "OPERATOR_ID": "",
  "DATE_LAST_UPDT": "",
  "TIME_LAST_UPDT": ""
}

Failure Response

Returned HTTP status indicates failure:

400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)

Returned JSON contains error information for the failed Serial Number Cross Reference creation:

{
  "MESSAGE": "",
  "MESSAGE_CODE": ""
}

Try the API