The Triage Web Service

8/3/2019 The Triage Web Service

http://slidepdf.com/reader/full/the-triage-web-service 1/5

The Triage Web Service ‘KentWideCRM’

https://api.swale.gov.uk/KentWideCRM/KentWideCRM.asmx

The web service contains the follow methods

CreateRequest

Checks that the subscriber to the scheme is valid the web service will use the authority code (or if not

authority code is passed then the information about the subject or contact is used to determine the authority

eg the easting/northing (598000/163000 is in Swale) and or elements of the address). Once the correct

authority is identified then the case can be processed)

FindAuthority

Returns details of an authority or all authorities that match that are part to the scheme.

FindRequest

Checks that the subscriber to the scheme is valid and returns the request.

FindRequestDetailsChecks that the subscriber to the scheme is valid and returns the request detail.

FindService

Returns the details of a service or all services for an authority or all authorities.

FindServiceDetail

Returns what details a service for an authority expects and their description.

Once the request has been created in the database the XML is then passed to the relevant authority web

service to deal with (eg create a case in their CRM or forward the details on to the appropriate part of the

authority). Any reference returned is updated in the database and passed back to calling app.

The TestRig which uses the Triage Web Service ‘KentWideCRM’

https://api.swale.gov.uk/KentWideCRMTestRig/KentWideCRMTestRig.aspx

This webpage will create example XML which can be submitted with the ‘Create Request’ button and the

returning XML is displayed.

The subscriber is ‘X’ and the password is ‘XYZ’.

The authorities and their available services are

Auth Code Authority Service Code Service

2002 Gravesham BC GENERAL General Enquiry

2001 Maidstone BC GENERAL General Enquiry

2255 Swale BC CTDIS Ctax Discount Forms

2255 Swale BC FT Fly Tipping

2255 Swale BC GENERAL General Enquiry

2003 Tunbridge Wells BC GENERAL General Enquiry

As this is a proof of concept the web service, updating of the Northgate system and any emailing is only on

Swale Development Systems.









XML definitions of the various Methods of the Web Service

CreateRequest(XmlRequest as String) as XmlDocument - Creates the request and send to council.

Passed XMLRequest xml string.<doc>

<request>

<subscribercode></subscribercode><subscriberpassword></subscriberpassword>

<authoritycode></authoritycode>

<servicecode></servicecode>

<contactpersoncitizenid></contactpersoncitizenid>

<contactpersonfullname></contactpersonfullname>

<contactpersontitle></contactpersontitle>

<contactpersonforename></contactpersonforename>

<contactpersonsurname></contactpersonsurname>

<contactcompanycitizenid></contactcompanycitizenid>

<contactcompanyname></contactcompanyname>

<contactllpguprn></contactllpguprn>

<contacthouse></contacthouse>

<contactstreet></contactstreet><contactlocality></contactlocality>

<contacttown></contacttown>

<contactcounty></contactcounty>

<contactcountry></contactcountry>

<contactpostcode></contactpostcode>

<contacteasting></contacteasting>

<contactnorthing></contactnorthing>

<contacthometelephone></contacthometelephone>

<contactworktelephone></contactworktelephone>

<contactfaxtelephone></contactfaxtelephone>

<contactmobiletelephone></contactmobiletelephone>

<contactemail></contactemail>

<contactpreferedmethod></contactpreferedmethod>

<subjectpersoncitizenid></subjectpersoncitizenid>

<subjectpersonfullname></subjectpersonfullname>

<subjectpersontitle></subjectpersontitle>

<subjectpersonforename></subjectpersonforename>

<subjectpersonsurname></subjectpersonsurname>

<subjectcompanycitizenid></subjectcompanycitizenid>

<subjectcompanyname></subjectcompanyname>

<subjectllpguprn></subjectllpguprn>

<subjecthouse></subjecthouse>

<subjectstreet></subjectstreet>

<subjectlocality></subjectlocality>

<subjecttown></subjecttown>

<subjectcounty></subjectcounty>

<subjectcountry></subjectcountry>

<subjectpostcode></subjectpostcode>

<subjecteasting></subjecteasting>

<subjectnorthing></subjectnorthing>

<subjecthometelephone></subjecthometelephone>

<subjectworktelephone></subjectworktelephone>

<subjectfaxtelephone></subjectfaxtelephone>

<subjectmobiletelephone></subjectmobiletelephone>

<subjectemail></subjectemail>

<subjectpreferedmethod></subjectpreferedmethod>

</request>

<requestdetail>

<detail1></detail1>

...<detail10></detail10>



</requestdetail>

</doc>

Returns the following XML Document.<doc>

<request>



<requestreference></requestreference><crmreference></crmreference>

<crmnotes></crmnotes>

</request>

<errors>

<error></error>

</errors>

</doc>

FindAuthority(XmlRequest as String) as XmlDocument - Returns details for a valid authority or list of

authorities.


<authoritycode>bigint </authoritycode> optional

<authorityname>varchar </authorityname> optional and part matches</doc>


<authority>

<code></code>

<name></name>

<address1></address1>





<telephone></telephone>

<fax></fax>

<email></email>

<website></website><webservice></webservice>

</authority>

</doc>

FindRequest(XmlRequest as String) as XmlDocument - Returns the details for requests.


<subscribercode>bigint </subscribercode> mandatory

<subscriberpassword>varchar </subscriberpassword> mandatory

<authoritycode>bigint </authoritycode>

<servicecode>varchar </servicecode>

<requestreference>varchar </requestreference>

</doc>


<request>

<reference></reference>

<subscibercode></subscibercode>

<subscibername></subscibername>


<authorityname></authorityname>


<servicename></servicename>

<crmreference></crmreference>

< crmnotes></crmnotes>

<contactpersoncitizenid></contactpersoncitizenid>

<contactpersonfullname><contactpersonfullname>

<contactpersontitle></contactpersontitle>

<contactpersonforename></contactpersonforename>

<contactpersonsurname></contactpersonsurname><contactcompanycitizenid></contactcompanycitizenid>

<contactcompanyname></contactcompanyname>



<contactllpguprn></contactllpguprn>

<contacthouse></contacthouse>

<contactstreet></contactstreet>

<contactlocality></contactlocality>

<contacttown></contacttown>

<contactcounty></contactcounty>

<contactcountry></contactcountry>

<contactpostcode></contactpostcode><contacteasting></contacteasting>

<contactnorthing></contactnorthing>

<contacthometelephone></contacthometelephone>

<contactworktelephone></contactworktelephone>

<contactfaxtelephone></contactfaxtelephone>

<contactmobiletelephone></contactmobiletelephone>

<contactemail></contactemail>

<contactpreferedmethod></contactpreferedmethod>

<subjectpersoncitizenid></subjectpersoncitizenid>

<subjectpersonfullname></subjectpersonfullname>

<subjectpersontitle></subjectpersontitle>

<subjectpersonforename></subjectpersonforename>

<subjectpersonsurname></subjectpersonsurname>

<subjectcompanycitizenid></subjectcompanycitizenid>

<subjectcompanyname></subjectcompanyname>

<subjectllpguprn></subjectllpguprn>

<subjecthouse>Swale House</subjecthouse>

<subjectstreet></subjectstreet>

<subjectlocality></subjectlocality>

<subjecttown></subjecttown>

<subjectcounty></subjectcounty>

<subjectcountry></subjectcountry>

<subjectpostcode></subjectpostcode>

<subjecteasting></subjecteasting>

<subjectnorthing></subjectnorthing>

<subjecthometelephone></subjecthometelephone>

<subjectworktelephone></subjectworktelephone>

<subjectfaxtelephone></subjectfaxtelephone>

<subjectmobiletelephone></subjectmobiletelephone>

<subjectemail></subjectemail>

<subjectpreferedmethod></subjectpreferedmethod></request>

</doc>

FindRequestDetail(XmlRequest as String) as XmlDocument - Returns the line details for requests.


<subscribercode>bigint </subscribercode> mandatory

<subscriberpassword>varchar </subscriberpassword> mandatory

<authoritycode>bigint </authoritycode>

<servicecode>varchar </servicecode>

<requestreference>varchar </requestreference>

<crmreference>varchar </crmreference>

</doc>


<requestdetail>

<reference></reference>

<crmreference></crmreference>





<servicedetailline></servicedetailline>

<servicedetaildescription></servicedetaildescription>

<servicedetail></servicedetail>

</requestdetail>

</doc>

FindService(XmlRequest as String) as XmlDocument - Returns details for a valid service or list of services.





<servicecode>varchar </servicecode> optional

</doc>


<service><authoritycode></authoritycode>




</service>

</doc>

FindServiceDetail(XmlRequest as String) as XmlDocument - Returns the line details for a valid service or list of

services.



<servicecode>varchar </servicecode> optional

</doc>Returns the following XML Document.<doc>

<servicedetail>





<notificationemail></notificationemail>

<detailline></detailline>

<detaildescription></detaildescription>

<detailmandatory></detailmandatory>

</servicedetail>

</doc>

The Triage Web Service

Documents

Transcript of The Triage Web Service