Forms/Download

Summary: In summary the above information and documentation is to provide the understanding the Forms/Download API and its associated information.

Description: This endpoint provides the ability to download the legal format or pdf format of the generated form.

API Name: /Forms/Download

HTTP Method: GET

HTTP Status Codes:

	HTTP Status Codes	Description
1	200	Ok
2	204	No Content
3	400	Bad Request
4	404	Not Found
5	500	Internal Server Error

OK example [200]

A legal format of the form is sent back to the client

No Content example [204]

For this case, only the http status code 204 will be returned.

Bad Request example [400]

    {
     "Data": null,
     "Status": "Failure",
     "Errors": [{
             "Code": "400",
             "Message": "FormId is not valid",
             "Detail": null,
             "Type": null,
             "TraceId": null,
             "ValidationErrors": [{
                     "Field": "formId",
                     "Code": 400,
                     "Message": "FormId is not valid"
                 }
             ]
         }
     ]
    }

Not Found example [404]

   {
      "Data": null,
      "Status": "Failure",
      "Errors": [{
              "Code": "404",
              "Message": "Form not found",
              "Detail": null,
              "Type": null,
              "TraceId": null,
              "ValidationErrors": null
          }
      ]
   }

Internal Server Error example [500]  
{
       "Data": null,
       "Status": "Failure",
       "Errors": [
           {
               "Code": "1001",
               "Message": "Some error message from server",
               "Detail": null,
               "Type": null,
               "TraceId": "d0ce45e6-df15-4a04-aaa8-c1c762c6828c",
               "ValidationErrors": []
           }
       ]
}

API Request

	Request Parameter	DataType	Validations	Mandatory	Description
1	formId	GUID		Y

API Response

	Response Field	DataType	Description
1	HttpResponseMessage	IDisposable

Case 1. Download Forms with “Not reconciled“ status

1. Consider you want to download an existing form with “Not reconciled“ status for a specific account

2. User will require following information to Download API: FormId, LFEId, UserId.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4. It is required an LFEId, UserId, and to add a Form Id as parameter but it is not required a body

Valid form Id that exists on the database with “Not reconciled“ status

LFEId (encrypted account number (alpha numeric value))

User Id (encrypted user id (alpha numeric value))

5. When user execute the valid API request, he gets the response the document

Case 2. Requesting to download a form using an invalid form id (the id number is not having the correct format, id having different number of digits than the required).

1. Consider you want to download a form, but an invalid form id is used as a parameter to search the form

2. User will require following information to Download API: FormId, LFEId, UserId.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4. It is required an LFEId, UserId, and to add a Form Id as parameter but it is not required a body

Invalid form Id

LFEId (encrypted account number (alpha numeric value))

User Id (encrypted user id (alpha numeric value))

5. When user execute the valid API request, he gets the response in the following format and no document is downloaded:

Bad Request example [400]

    {
     "Data": null,
     "Status": "Failure",
     "Errors": [{
             "Code": "400",
             "Message": "FormId is not valid",
             "Detail": null,
             "Type": null,
             "TraceId": null,
             "ValidationErrors": [{
                     "Field": "formId",
                     "Code": 400,
                     "Message": "The value 'Form Id' is not valid for FormId"
                 }
             ]
         }
     ]
    }

Case 3. Requesting to download a form with “Failed” parameter

1. Consider you want to download an existing form with “Failed” status for a specific account

2. User will require following information to Download API: FormId, LFEId, UserId.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4. It is required an LFEId, UserId, and to add a Form Id as parameter but it is not required a body

Form Id of a form with “Failed” status

LFEId (encrypted account number (alpha numeric value))

User Id (encrypted user id (alpha numeric value))

5. When user execute the valid API request, he gets the response in the following format:

Not Found example [404]

   {
      "Data": null,
      "Status": "Failure",
      "Errors": [{
              "Code": "404",
              "Message": "Form not found",
              "Detail": null,
              "Type": null,
              "TraceId": null,
              "ValidationErrors": null
          }
      ]
   }

Case 4. Requesting to download a form with “Reconciled” parameter

1.Consider you want to download an existing form with “Reconciled” status for a specific account

2.User will require following information to Download API: FormId, LFEId, UserId.

3.To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4.It is required an LFEId, UserId, and to add a Form Id as parameter but it is not required a body

Form Id of a form with “Reconciled” status

LFEId (encrypted account number (alpha numeric value))

User Id (encrypted user id (alpha numeric value))

5.When user execute the valid API request, he gets the response in the following format:

Not Found example [404]

   {
      "Data": null,
      "Status": "Failure",
      "Errors": [{
              "Code": "404",
              "Message": "Form does not exist.",
              "Detail": null,
              "Type": null,
              "TraceId": null,
              "ValidationErrors": null
          }
      ]
   }

Case 5. Requesting to download a form that is not existing in the database

1. Consider you want to download a not existing form for a specific account

2. User will require following information to Download API: FormId, LFEId, UserId.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4. It is required an LFEId, UserId, and to add a Form Id as parameter but it is not required a body

Not existing form Id

LFEId (encrypted account number (alpha numeric value))

User Id (encrypted user id (alpha numeric value)

5. When user execute the valid API request, he gets the response in the following format:

Not Found example [404]

   {
      "Data": null,
      "Status": "Failure",
      "Errors": [{
              "Code": "404",
              "Message": "Form does not exist.",
              "Detail": null,
              "Type": null,
              "TraceId": null,
              "ValidationErrors": null
          }
      ]
   }