Endpoints

Get transcript requests without a response

Allows supplier to retrieve a list of transcript requests with a response.

Resource URL

GET /api/transcriptrequests/no_response

Resource Information

Requires authentication?	Content-Type
Yes	application/json

Example Request

GET /api/transcriptrequests/no_response
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

Example Responses

Success

Http response code: 200

[
    {
        "RequestID": "C20150622003421",
        "RequestDate": "2015-04-23T18:25:43.511Z"
    },
    {
        "RequestID": "C20150622003421",
        "RequestDate": "2015-04-23T18:25:43.511Z"
    }
]

Failure

Http response code: 400

{
    "Message": "No requests found"
}

Get transcript request detail

Allows supplier to retrieve the detail of a particular transcript request.

Resource URL

GET /api/transcriptrequests/:id

Resource Information

Requires authentication?	Content-Type
Yes	application/json

JSON Parameters

None

Example Request

GET /api/transcriptrequests/C20150622003421/
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

Example Responses

Success

Http response code: 200

[
    {
        "RequestID": "C20150622003421",
        "RequestDate": "2015-04-23T17:15:53.115Z ",
        "PESCXML": "<TranscriptRequest xmlns="urn:org:pesc:message:TranscriptRequest:v1.0.0" xmlns:core="urn:org:pesc:core:CoreMain:v1.0.0..."
    }
]

Failure

HTTP Code	Description
400	Invalid value.
400	Cannot find transcript request ID.

Http response code: 400

{
    "Message": "Cannot find transcript request ID."
}

Send transcript request response

Allows supplier to send a response to the transcript request.

Resource URL

POST /api/transcriptrequests/:id/responses

Resource Information

Requires authentication?	Content-Type
Yes	application/json

JSON Parameters

None

Example Request

POST /api/transcriptrequests/C20150622003421/responses
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

{
    "PESCXML": "<TranscriptResponse xmlns="urn:org:pesc:message:TranscriptRequest:v1.0.0"…"
}

Example Responses

Success

Http response code: 200

{
    "RequestID": " C20150622003421",
    "PESCXML": "<TranscriptResponse xmlns="urn:org:pesc:message:TranscriptRequest:v1.0.0"..."
}

Failure

HTTP Code	Description
400	Invalid value.
400	Cannot find transcript request ID.

Http response code: 400

{
    "Message": "Cannot find transcript request ID."
}

Send transcript belonging to a transcript request

Allows supplier to send a transcript.

Resource URL

POST /api/transcriptrequests/:id/transcripts

Resource Information

Requires authentication?	Content-Type
Yes	application/json

JSON Parameters

None

Example Request

POST /api/transcriptrequests/C20150622003421/transcripts
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

{
    "PESCXML": "_XML_"
}

Example Responses

Success

Http response code: 200

{
    "RequestID": "C20150622003421",
    "PESCXML": "<TranscriptAcknowledgment xmlns="urn:org:pesc:message:TranscriptAcknowledgment…"
}

Note: PESCXML will contain a document of type Transcript Acknowledgment

Failure

HTTP Code	Description
400	Invalid value.
400	Cannot find transcript request ID.

Http response code: 400

{
    "Message": "Cannot find transcript request ID."
}

Get transcripts without a response

Allows Consumer to retrieve a list of transcripts without a response.

Resource URL

GET /api/transcripts/no_response

Resource Information

Requires authentication?	Content-Type
Yes	application/json

Example Request

GET /api/transcripts/no_response
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

Example Responses

Success

Http response code: 200

[
    {
        "RequestID": " C20150622003421",
        "RequestDate": "2015-04-23T18:25:43.511Z",
    }
]

Failure

Http response code: 400

{
    "Message": "No transcripts found."
}

Get transcript detail

Allows consumer to retrieve the detail of a particular transcript.

Resource URL

GET /api/transcripts/:id

Resource Information

Requires authentication?	Content-Type
Yes	application/json

JSON Parameters

None

Example Request

GET /api/transcripts/C20150622003421/
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

Example Responses

Success

Http response code: 200

[
    {
        "RequestID": "8ee5390e-65b8-493b-a730-25bcd7c01f57",
        "PESCXML": "<CollegeTranscript xmlns="urn:org:pesc:message:CollegeTranscript:v1.0.0" xmlns:core="urn:org:pesc:core:CoreMain:v1.0.0..."
    }
]

Failure

HTTP Code	Description
400	Invalid value.
400	Cannot find transcript ny ID.

Http response code: 400

{
    "Message": "Cannot find transcript by ID."
}

Send transcript acknowledgment

Allows consumer to send an acknowledgment to the transcript.

Resource URL

POST /api/transcripts/:id/acknowledgment

Resource Information

Requires authentication?	Content-Type
Yes	application/json

JSON Parameters

None

Example Request

POST /api/transcripts/C20150622003421/acknowledgment
Authorization: bearer xF1ehA283MnH62sdyEZEd1C6X8cx

{
    "PESCXML": "<TranscriptAcknowledgment xmlns="urn:org:pesc:message:TranscriptAcknowledgment:v1.0.0""
}

Example Responses

Success

Http response code: 200

{
    "RequestID": "C20150622003421",
    "PESCXML": "<TranscriptAcknowledgment xmlns="urn:org:pesc:message:TranscriptAcknowledgment:v1.0.0""
}

Failure

HTTP Code	Description
400	Invalid value.
400	Cannot find transcript by ID.

Http response code: 400

{
    "Message": "Cannot find transcript by ID."
}