Web Services Reference for Oracle Billing Insight > Examples of Web Services > Examples of the Service Agreements Web Service >

Example of Creating a Service Agreement

This example shows you how to use the service_agreements Web service to create a service agreement.

Operation

Use the following operation to create a service agreement:

POST /serviceAgreements

Sample URL

The following is a sample URL for this Web service example:

http://myhost.example.com:7017/rs/api/v2/serviceAgreements

Sample XML Input Rules

The following are the XML input rules:

• Tags in bold are required.
• If tags are not present, then the corresponding fields are set to the default values.
• The value of serviceType must be in the SERVICE_TYPE_CD in the EDX_RPT_SERVICE_TYPE_DIM table in the Online Analytic Processing (OLAP) database.

Sample XML Input

The following is an example of XML input:

<serviceAgreementInfo>
<serviceAgreementId>BS1|7836380B2B1|878-457-B2B1</serviceAgreementId>
<billerId>BS1</billerId>
<accountNumber>7836380B2B1</accountNumber>
<saNumber>878-457-B2B1</saNumber>
<serviceType>UNK</serviceType>
<description>xxx</description>
<subscriber>xxx</subscriber>
</serviceAgreementInfo>

Sample JSON Input

The following is an example of JSON input:

{
"billerId":"BS1",
"accountNumber": "AC-B2B-64521A",
"saNumber": "123-111-1101",
"serviceType": "UNK",
"subscriber": "subscriber name",
"startDate":{
"pattern":"MM/dd/yyyy",
"value":"12/12/2014"
},
"zoning":"z",
"description": "desc"
}

Response Message

The following is an example of the response message:

Service Agreement Create Success

Visit <link>http://myhost.example.com:7017/rs/api/v2/serviceAgreements/BS1%7C7836380B2B1%7C878-457-B2B1</link>