UpdateProcessedAsnStatus (PUT)

Overview

This call updates ASN status. Valid ASN Number is mandatory to mark ASN success.

 

URL Format: https://<Instance>/smartInterfaceAPI/api/ASN/ASNStatus

Request
{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

 

Response
{
  "data": {},
  "statusCode": "String",
  "errorDetails": [
    {
      "key": "string",
      "errors": [
        {
          "errorCode": "string",
          "errorDescription": "string"
        }
      ]
    }
  ],
  "successDetails": [
    {
      "key": "String"
    }
  ]
}

 

Examples

Success Scenario - Request

{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Success Scenario - Response

{
  "data": null,
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "CC10_Inactive"
    }
  ]
}

 

Error Scenario - Request

{
   "model": [
      {
         "key": "ASN-08:16-00035_1",
         "description": "success",
         "status": "string",
         "sourceSystemName": "123",
         "sourceSystemValue": "123",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Error Scenario - Response

{
  "data": null,
  "statusCode": "400",
  "errorDetails": [
    {
      "key": "ASN-03:18-000001",
      "errors": [
        {
          "errorCode": "DataValidation",
          "errorDescription": "Invalid ASN Number"
        }
      ]
    }
  ],
  "successDetails": []
}

 

Data Elements
 

Update processed ASN status

S.No.

Property

Required?

Data type

Description

Validations / Exceptions

1

Model

No

List of UpdateProcessedDocumentStatusModel object

Check data type UpdateProcessedDocumentStatusModel for details

 
 

Model

S.No.

Property

Required?

Data type

Description

Validations / Exceptions

1.1

Status

No

ErrorDetail object

Check data type ErrorDetail for details

 

1.2

Key

Yes

String

Key of the entity

 

  • Key is Mandatory.

     

 

  • Invalid ASN Number.

     

1.3

Description

No

String

Description of the entity

 

1.4

SourceSystemDetailsName

No

String

Name of the entity

 

1.5

SourceSystemDetailsValue

No

String

Value of the entity

 

1.6

Lob

No

String

line-of-business

 

1.7

ErrorCode

No

String

Check data type Error Code