Download Disbursement Instructions

GET 
/disbursements/:id/instructions

Allows an SDP user to download the raw CSV file that was uploaded when creating the disbursement. This will only return results after instructions have been attached to a draft disbursement.

Request

Path Parameters

id stringrequired

ID of the Disbursement

Responses

200

Disbursement CSV file

Response Headers

• Content-Disposition string

  The filename of the returned CSV file.

• Content-Type string

  text/csv

text/csv

Schema

Schema

any

response

400

Bad Request

Response Headers

text/csv

Schema

Schema

error string
extras object
foo string
message string

Example (from schema)

{
  "error": "Invalid request",
  "extras": {
    "foo": "bar",
    "message": "Invalid request parameters"
  }
}

application/json

Schema

Schema

any

response

{
  "error": "Invalid request",
  "extras": {
    "foo": "bar",
    "message": "Invalid request parameters"
  }
}

401

Unauthorized

Response Headers

text/csv

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

application/json

Schema

Schema

any

response

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

Response Headers

text/csv

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

application/json

Schema

Schema

any

response

{
  "error": "Forbidden"
}

404

Not Found

Response Headers

text/csv

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

application/json

Schema

Schema

any

response

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

Loading...