Offer on DreamApply Knowledge Base

Offer type

Mon, 01 Jan 0001 00:00:00 +0000

Represents the type of the application offer.

URI

/api/v9/applications/ID/offers/ID/type

Get the offer type

A request with the GET verb returns the offer type about the application offer in question.

Syntax

GET /api/v9/applications/123/offers/321/type
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/type"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer type was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

{
 "id": 12,
 "type": "/api/v4/applications/offers/types/12"
}

Response

"Conditionally accepted"

Set the offer type

Set the offer type to the application offer (identified by its ID) in question. This will check if the given type is a valid offer type that can be used in the system. On successful validation of the given type, it will be assigned as the type of the application offer in question.

Offer subject

Mon, 01 Jan 0001 00:00:00 +0000

Represents the subject line of the application offer.

URI

/api/v9/applications/ID/offers/ID/subject

Get the offer subject

A request with the GET verb returns the offer letter subject line.

Syntax

GET /api/v9/applications/123/offers/321/subject
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/subject"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer letter subject line was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

"You are accepted to a study place"

Set the offer subject

Set the offer letter subject line to the application offer (identified by its ID).

Offer comments

Mon, 01 Jan 0001 00:00:00 +0000

Represents the offer letter text/comments for the application offer.

URI

/api/v9/applications/ID/offers/ID/comments

Get the offer comments

A request with the GET verb returns the offer letter text (“comments”) for this particular offer (identified by offer ID).

Syntax

GET /api/v9/applications/123/offers/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/comments"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The offer letter text (“comments”) was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

"Hello\n\nCongratulations, you are now accepted to ...."

Set the offer comments

Set the offer letter text (“comments”) to the application offer (identified by its ID).

Offer confirmation

Mon, 01 Jan 0001 00:00:00 +0000

Represents an offer confirmation.

Syntax

/api/v9/applications/ID/offers/ID/confirm
Host: apply.example.edu
Authorization: DREAM apikey="..."

Confirm an offer

This action confirms the offer and sends it out to the applicant using the current offer details:

Review and update the offer details before confirming the offer. Otherwise, DreamApply will proceed with the values most recently saved in the system.

Offer decision

Mon, 01 Jan 0001 00:00:00 +0000

Represents the application offer decision.

Syntax

/api/v9/applications/ID/offers/ID/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."

Get the offer decision

A request with the GET verb returns the decision that the applicant has made (or has been made by admin on behalf of the applicant) regarding this offer.

It can be one of three:

Final: The offer was accepted by the applicant
Declined: The offer was declined by the applicant
None: No decision yet

Syntax

GET /api/v9/applications/123/offers/321/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 "https://apply.example.edu/api/v9/applications/123/offers/321/decision"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The decision was successfully returned
`404 Not Found`	The application does not have this offer

Example response

Response

"Declined"

Set the offer decision

Set the decision on behalf of the applicant regarding a specific offer. For example, you can mark an offer to be declined, or make it the final decision (acceptance) for an applicant.

Offer on DreamApply Knowledge Base

Offer type

GET Get the offer type

Example request

Response headers

Response codes

Example response

PUT Set the offer type

Offer subject

GET Get the offer subject

Example request

Response headers

Response codes

Example response

PUT Set the offer subject

Offer comments

GET Get the offer comments

Example request

Response headers

Response codes

Example response

PUT Set the offer comments

Offer confirmation

POST Confirm an offer

Offer decision

GET Get the offer decision

Example request

Response headers

Response codes

Example response

PUT Set the offer decision

Get the offer type

Set the offer type

Get the offer subject

Set the offer subject

Get the offer comments

Set the offer comments

Confirm an offer

Get the offer decision

Set the offer decision