SCS Reject Contract API

Overview

This document defines the capabilities of the RejectContract method. This method allows the consumer of the service to ‘Reject’ a previously submitted contract. The contract, when rejected, can be assigned a reject reason similar to when a user rejects a contract in the SCS contract UI. The contract can only be Rejected if the contract is already in ‘Pending’ or ‘Pending Billed’ status in SCS. Error messaging is returned if the contract does not meet the validation for contract status or any other criteria outlined in this documentation so that consumers of the service know exactly what to fix such that these transactions can be resubmitted to the RejectContract method to be processed.

Specifications Data Format

The following table represents the data formats used in the XML coding (Use to reference the “Format” column in the following XML schema tables)


Data Type	Description	Example
X(10)	Characters of max length of 10	ABCDEABCDE
Date	yyyy-mm-dd	2000-12-21
DateTime	yyyy-mm-ddThh:mm:ss	2000-12-21T12:24:40
N(5)	Number,max length of 5	12345
N(8,2)	Number with two decimals, max length of 8	123456.78
Boolean	Boolean true or false	true

Request Schema items are noted as (R)equired, (O)ptional, or (C)onditional in the documentation provided.

Location


Environment	URL
UAT	https://uat.fiadmin.com/scs.webservice/contractservice.asmx
Production	https://www.scsautoexpress.com/scs.express.webservice/contractservice.asmx

Request

Reject Contract Request Object


Tag	Format	Validate	Description
TpaCode	X(4)	R	Third Party Administrator Code
UserId	X(30)	R	User ID issued to the requesting system
Password	X(255)	R	Password issued to the requesting system
ContractNumber	X(20)	R	Contract Number to be validated for Pending or Pending billed.
DealerNumber	X(18)	R	Dealer Number
StatusReasonDescription	X(100)	C	Required if SCS is configured to require a status reason upon rejection of the contract. Any value provided must be associated to Contract Status “Rejected” in the Contract Status Reason list in SCS.
StatusReasonNote	X(100)	O	Status reason note. Optional

Sample Soap Request

<soap:Envelope>
    <soap:Body>
        <RejectContract>
            <request>
                <UserId>xxxxx</UserId>
                <Password>xxxxxxx</Password>
                <TpaCode>FIAS</TpaCode>
                <ContractNumber>SELLER12345</ContractNumber>
                <DealerNumber>DAP12345678ABC</DealerNumber>
                <StatusReasonDescription>Reason Description Here</StatusReasonDescription>
                <StatusReasonNote>Test Note Here</StatusReasonNote>
            </request>
        </RejectContract>
    </soap:Body>
</soap:Envelope>

Response

RejectContractResponse Object


Tag	Valid Values	Description
ContractNumber		Returns the contract number provided in the request.
Response Code	1, 0	1 = Successful, the contract was rejected 0 = Contract was not rejected, see Message
Messages		Collection of Messages. See Message Object.

Message Object


Tag	Valid Values	Description
Type	1, 2, 3, 4	1 – Error, 2 – Info, 3 – Warning, 4 – Success
Code	Various	Provides the associated code with each message text.
Text		Message associated to the response, if any. See Error Messages list below for more information.

Error Messages


Message Type	Error Code	Message
Error	VD0009	Authentication Failed.
Error	WSSECUR001	You do not have necessary permission to execute this web method.
Error	rfvTpaCode	TPA Code is required.
Error	VD0003	TPA is invalid.
Error	rfvDealerNumber	Seller Number is required.
Error	DLRNOTEXIST	Dealer does not exist.
Error	rfvContractNumber	Contract Number is required.
Error	VD0001	Invalid contract number.
Error	INV_STATUS_DESC	Invalid Status Reason Description.
Error	STATUS_DESC_REQD	Status Reason Description is required.
Error	REJECT_CNTR_001	Only Contracts in Pending or Pending Billed Statuses can be Rejected. (Status {0}) Note: 0 – Is a parameter which displays contract status e.g. Rejected, Void, Active, Cancelled
Error	REJECT_CNTR_003	Contract could not be rejected. Contract is locked for editing.
Error	REJECT_CNTR_004	Cannot Reject Contract. Incorrect Dealer.

Sample SOAP Response for Successful Request

<soap:Envelope>
    <soap:Body>
        <RejectContractResponse>
            <RejectContractResult>
                <ResponseCode>1</ResponseCode>
                <Messages/>
                <ContractNumber/>
            </RejectContractResult>
        </RejectContractResponse>
    </soap:Body>
</soap:Envelope>

Sample SOAP Response for Unsuccessful Request

<soap:Envelope>
    <soap:Body>
        <RejectContractResponse>
            <RejectContractResult>
                <ResponseCode>0</ResponseCode>
                <Messages>
                    <Message>
                        <Type>1</Type>
                        <Code>REJECT_CNTR_003</Code>
                        <Text>Contract could not be rejected. Contract is locked for editing.</Text>
                    </Message>
                </Messages>
                <ContractNumber/>
            </RejectContractResult>
        </RejectContractResponse>
    </soap:Body>
</soap:Envelope>

12 Reject Contract API

SCS Reject Contract API#

Overview#

Specifications Data Format#

Location#

Request#

Reject Contract Request Object#

Sample Soap Request#

Response#

RejectContractResponse Object#

Message Object#

Error Messages#

Sample SOAP Response for Successful Request#

Sample SOAP Response for Unsuccessful Request#