form2290

GET form2290/GetSchedule1

Request (URI)

Name Type Description Condition
SubmissionId string

Required

RecordIds string

Required

Response

Name Type Description
SubmissionId globally unique identifier

Submission Identifier

Form2290pdfRecords Collection of ApiSchedule1Record

It will return the PDF generation status.

Errors Collection of Error

It will show the detailed information about the 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": "08383e18-b4c8-4d05-a396-c4c8fd11f11d",
  "Form2290pdfRecords": [
    {
      "RecordId": "c767371d-953b-423d-9cb1-bc2fa65c2e0b",
      "Schedule1S3Path": null
    },
    {
      "RecordId": "c767371d-953b-423d-9cb1-bc2fa65c2e0b",
      "Schedule1S3Path": null
    }
  ],
  "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

GET form2290/GetSchedule1

Request (URI)

Name Type Description Condition
SubmissionId string

Required

RecordIds string

Required

Response

Name Type Description
SubmissionId globally unique identifier

Submission Identifier

Form2290pdfRecords Collection of ApiSchedule1Record

It will return the PDF generation status.

Errors Collection of Error

It will show the detailed information about the 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": "08383e18-b4c8-4d05-a396-c4c8fd11f11d",
  "Form2290pdfRecords": [
    {
      "RecordId": "c767371d-953b-423d-9cb1-bc2fa65c2e0b",
      "Schedule1S3Path": null
    },
    {
      "RecordId": "c767371d-953b-423d-9cb1-bc2fa65c2e0b",
      "Schedule1S3Path": null
    }
  ],
  "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"
    }
  ]
}