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

400

Bad request, invalid request parameters

*/*

Schema

Schema

error string

Details about the error

extras

object

object

Example (from schema)

{
  "error": "Invalid input",
  "extras": {
    "field_foo": "field_foo is required",
    "field_bar": "field_bar needs to be an integer"
  }
}

401

Unauthorized

*/*

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

Example (from schema)

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

Example

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

403

Forbidden

*/*

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

application/json

Schema

Schema

any

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

404

Disbursement Not Found

*/*

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "string",
  "extras": {
    "status": 0,
    "message": "string"
  }
}

application/json

Schema

Schema

any

Example (from schema)

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

Example

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

Loading...