SCS Activate Contract API

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

ActivateContract

This method can be used to activate a pending contract in SCS.

Note: ActivateContract service is a function of the eRating web service. eRating URL should be used for contract activation.

Request Schema

ActivateContract Object

Tag	Format	Req/Opt/ Cond	Valid values	Description
TpaCode	X(4)	R		Third Party Administrator Code. The three letter code assigned to each supported SCS Auto provider.
UserId	X(30)	R		User ID. Required for secure access to SCS Auto Contract Activation Web Service.
Password	X(255)	R		Password. Required for secure access to SCS Auto Contract Activation Web Service.
ContractNumber	X(20)	R		Contract Number to activate. This is the same contract number that is issued by SCS and sent back in the GenerateContractResponse object.
UserIdDisplay	string	O		Obsolete. Not used.
Rerate	Boolean	O	True or False	Contract will Rerate by default or “True”. Rerate tag set to “False” will not rerate the contract when activated.

Sample Request Default (Rerate)

<?xml version="1.0" encoding="utf-8" ?>

<ActivateContract>

<ActivateContractRequest>

<TpaCode>ABC</TpaCode >

<UserId>ServiceUser</UserId>

<Password>Admin123</Password>

<ContractNumber>CN00089</ContractNumber>

</ActivateContractRequest>

</ActivateContract>

Sample Request Default (No Rerate)

<?xml version="1.0" encoding="utf-8" ?>

<ActivateContract>

<ActivateContractRequest>

<TpaCode>ABC</TpaCode >

<UserId>ServiceUser</UserId>

<Password>Admin123</Password>

<ContractNumber>CN00089</ContractNumber>

<Rerate>False</Rerate>

</ActivateContractRequest>

</ActivateContract>

**Response Schema**

ActivateContractResponse Object

Tag	Format	Req/Opt/ Cond	Valid values	Description
ResponseCode	N(1)	R	1. – Failure 2. – Success	Response Code
Messages		O		Collection of Message objects which will contain list of errors in the event that a contract did not get activated (i.e. if the ResponseCode was 0) or possibly Info or Warning messages if a contract did get activated (i.e. the ResponseCode was 1).

Message Object

Tag	Format	Req/ Opt/ Cond	Valid values	Description
Code	String	O		Reserved for future use
Type	Integer	R	1. – Error 2. – Info 3. – Warning 4. - Success	Message Type
Text	String	R		Message Text

Error Messages

Message Type	Message Text
Error	Invalid User ID or Password.
Error	Invalid contract number.
Error	TPA Code is required.
Error	TPA is invalid.
Error	Contract is locked.
Error	Contract <contract #> cannot be activated.
Error	Only pending contract can be activated.