DokuWiki

This is an old revision of the document!

payloads:delete_payload

The payloads web service is a REST structured service that derives its functionality based on syntax used when calling the web service. To delete a payload from a repository, call the payloads web service with a repository name and the payload file name.

Important: The payload must be locked prior to retrieving it.

Purpose: Delete A Payload From A Repository.

Request Endpoint

Method	URL
DELETE	https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/{repository}/{payload_name}

Variables:

Variable	Usage	Description
{repository}	Required	The name of the repository
{payload_name}	Required	The name of the payload

Request Body

N/A

Request Headers

Key	Value
access_token	{soft-token}

JSON Request Parameters

N/A

Notes:

Any condition that results in an unsuccessful call to the payloads web service will produce a JSON formatted response with a code and message property populated.

Sample Request

Endpoint:

https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads/retrieve/standard_testagent1-202007140415-00003.1.1_200723151458170.xml

Sample Response (Note: Most of the Base64 image text was removed for readability.)

Status Code: 200

<?xml version="1.0" encoding="utf-8"?>
<RESPONSE_GROUP PRIAVersionIdentifier="2.4.2">
    <REQUESTING_PARTY _Name="TEST SUBMITTER 1" _StreetAddress="1001 APEX Submission Ave." _StreetAddress2="" _City="Sub City" _State="CA" _PostalCode="91234" _Identifier="35" />
    <SUBMITTING_PARTY LoginAccountIdentifier="bzsub1" _Name="AGENT - TEST AGENT 1" />
    <RESPONSE ResponseDateTime="2020-07-23T14:50:24">
        <KEY _Name="Comment" _Value="Sample comment" />
        <RESPONSE_DATA>
            <PRIA_RESPONSE _RelatedDocumentsIndicator="true">
                <PACKAGE CountyFIPSCode="901" StateFIPSCode="06" SecurityType="1" Priority="Standard">
                    <PRIA_DOCUMENT _Code="Deed" DocumentSequenceIdentifier="1" _UniqueIdentifier="ABC-123" RequestChecksumAlgorithm="SHA384" RequestChecksumValue="0C7580F7-7E3A-4615-A495-55EB66E299A6" ResponseChecksumAlgorithm="SHA384" ResponseChecksumValue="94BE9B16-F97B-4525-BD00-D331F1E7C517">
                        <GRANTOR _FirstName="John" _LastName="Doe" NonPersonEntityIndicator="true" />
                        <GRANTEE _FirstName="Jane" _LastName="Doe" NonPersonEntityIndicator="true" />
                        <RECORDABLE_DOCUMENT>
                            <_ASSOCIATED_DOCUMENT _InstrumentNumber="2009003899200" _RecordingDate="2009-02-25" />
                        </RECORDABLE_DOCUMENT>
                        <EMBEDDED_FILE _PagesCount="3">
                            <DOCUMENT>SUkqAA7qAAAtVZDKI+R4jhkhyPkfI6I6I4hfI4EGAXI4y4UuyODkcUjg5HA+LkR4uKXyOyOFI4YORcyPl2YiOBgjxHZeL5HIuyPnGR4ui6I6I</DOCUMENT>
                        </EMBEDDED_FILE>
                        <STATUS _Code="Rejected">
                            <RECORDING_ERROR _Code="99999" _Description="This is a automatic rejection test message." _OfficersName="John Doe" />
                        </STATUS>
                    </PRIA_DOCUMENT>
                </PACKAGE>
                <RECORDING_TRANSACTION_IDENTIFIER _Value="TESTAGENT1-202007140415-00003.1.1" SecondaryValue="3453453453" />
            </PRIA_RESPONSE>
        </RESPONSE_DATA>
    </RESPONSE>
</RESPONSE_GROUP>

OR

Status Code: 500 (When an error occurs.)

{
    "Exception": {
        "Code": "PayloadFileLockError",
        "Message": "The payload standard_testagent1-202007140415-00025.1.1_200723151419729.xml not locked."
    }
}