Download Disbursement 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.

Path Parameters

• id string required

  ID of the Disbursement

Responses

• 200
• 400
• 401
• 403
• 404

---

Disbursement CSV file

Response Headers

• Content-Disposition string

  The filename of the returned CSV file.

• Content-Type string

  text/csv

text/csv

• Schema
• response

---

Schema

any

Bad Request

Response Headers

text/csv

• Schema
• Example (from schema)

---

Schema

• error string
• extras object

  foo string

  message string

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

application/json

• Schema
• response

---

Schema

any

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

Unauthorized

Response Headers

text/csv

• Schema
• Example (from schema)

---

Schema

• error string
• extras object

  status number

  message string

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

application/json

• Schema
• response

---

Schema

any

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

Forbidden

Response Headers

text/csv

• Schema
• Example (from schema)

---

Schema

• error string

{
  "error": "Forbidden"
}

application/json

• Schema
• response

---

Schema

any

{
  "error": "Forbidden"
}

Not Found

Response Headers

text/csv

• Schema
• Example (from schema)

---

Schema

• error string
• extras object

  status number

  message string

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

application/json

• Schema
• response

---

Schema

any

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

Loading...