form2290

POST form2290/Transmit

This API method Transmits the return.

Request

Name Type Description Condition
SubmissionId globally unique identifier

Required

RecordIds Collection of globally unique identifier

Request Formats

application/json, text/json

Sample:
{
  "SubmissionId": "30ea205d-1cf6-48bb-9efd-2ef07b153410",
  "RecordIds": [
    "a24fdc31-7033-4dc7-9a94-106e9ef9608d",
    "b2d05177-d85a-4ff6-bf3e-0c633de4aced"
  ]
}

Response

Name Type Description
SubmissionId globally unique identifier

Form2290Records Form2290TransmitRecord

Errors Collection of Error

StatusCode integer

It will return the status codes like 200, 300, etc., Refer Status Codes.

StatusName string

It will return the name of status code.

StatusMessage string

It will return the detailed message of status code.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "06ecb99d-a005-4d99-9a35-951c8de3d120",
  "Form2290Records": {
    "SuccessRecords": [
      {
        "Sequence": null,
        "RecordId": "77151c30-12f6-49ed-aef7-80624dbdbad7",
        "RecordStatus": null,
        "StatusTs": "2020-06-10 12:05:05 +05:30"
      },
      {
        "Sequence": null,
        "RecordId": "77151c30-12f6-49ed-aef7-80624dbdbad7",
        "RecordStatus": null,
        "StatusTs": "2020-06-10 12:05:05 +05:30"
      }
    ],
    "ErrorRecords": [
      {
        "RecordId": "199b67df-623a-43cf-a796-caeb5ecc5215",
        "RetSeqId": null,
        "ReportingVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "PriorYearSuspendedVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "CreditVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "Errors": [
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      },
      {
        "RecordId": "199b67df-623a-43cf-a796-caeb5ecc5215",
        "RetSeqId": null,
        "ReportingVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "PriorYearSuspendedVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "CreditVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "Errors": [
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    },
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    }
  ]
}

form2290

POST form2290/Transmit

This API method Transmits the return.

Request

Name Type Description Condition
SubmissionId globally unique identifier

Required

RecordIds Collection of globally unique identifier

Request Formats

application/json, text/json

Sample:
{
  "SubmissionId": "30ea205d-1cf6-48bb-9efd-2ef07b153410",
  "RecordIds": [
    "a24fdc31-7033-4dc7-9a94-106e9ef9608d",
    "b2d05177-d85a-4ff6-bf3e-0c633de4aced"
  ]
}

Response

Name Type Description
SubmissionId globally unique identifier

Form2290Records Form2290TransmitRecord

Errors Collection of Error

StatusCode integer

It will return the status codes like 200, 300, etc., Refer Status Codes.

StatusName string

It will return the name of status code.

StatusMessage string

It will return the detailed message of status code.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "06ecb99d-a005-4d99-9a35-951c8de3d120",
  "Form2290Records": {
    "SuccessRecords": [
      {
        "Sequence": null,
        "RecordId": "77151c30-12f6-49ed-aef7-80624dbdbad7",
        "RecordStatus": null,
        "StatusTs": "2020-06-10 12:05:05 +05:30"
      },
      {
        "Sequence": null,
        "RecordId": "77151c30-12f6-49ed-aef7-80624dbdbad7",
        "RecordStatus": null,
        "StatusTs": "2020-06-10 12:05:05 +05:30"
      }
    ],
    "ErrorRecords": [
      {
        "RecordId": "199b67df-623a-43cf-a796-caeb5ecc5215",
        "RetSeqId": null,
        "ReportingVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "PriorYearSuspendedVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "CreditVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "Errors": [
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      },
      {
        "RecordId": "199b67df-623a-43cf-a796-caeb5ecc5215",
        "RetSeqId": null,
        "ReportingVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "PriorYearSuspendedVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "CreditVehicles": [
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          },
          {
            "Errors": [
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              },
              {
                "VehSeqId": "1",
                "Code": "404",
                "Name": "NotFound",
                "UserMessage": "Record not found",
                "APIMessage": "Record not found",
                "Type": "Error"
              }
            ]
          }
        ],
        "Errors": [
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "Code": "404",
            "SeqId": "1",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    },
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    }
  ]
}