CollectiveAPIWebService

Click here for a complete list of operations.

ServiceRequest_Create

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /API-R1604/CollectiveAPI.asmx HTTP/1.1
Host: collectiveapi.bartec-systems.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bartec-systems.com/ServiceRequest_Create"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ServiceRequest_Create xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
      <ServiceRequest_Location />
      <serviceLocationDescription>string</serviceLocationDescription>
      <DateRequested>dateTime</DateRequested>
      <ServiceTypeID>int</ServiceTypeID>
      <ServiceStatusID>int</ServiceStatusID>
      <reporterContact>
        <Title xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Title>
        <Forename xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Forename>
        <OtherNames xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</OtherNames>
        <Surname xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Surname>
        <Email xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Email>
        <Telephone xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Telephone>
        <Telephone2 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Telephone2>
        <Telephone3 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Telephone3>
        <SpecialCommunicationNeeds xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</SpecialCommunicationNeeds>
        <ExternalReference xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ExternalReference>
        <ReporterType xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ReporterType>
      </reporterContact>
      <reporterBusiness>
        <Name xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Name>
        <AddressLine1 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</AddressLine1>
        <AddressLine2 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</AddressLine2>
        <Street xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Street>
        <Locality xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Locality>
        <Town xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Town>
        <PostCode xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</PostCode>
        <ExternalReference xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ExternalReference>
      </reporterBusiness>
      <source>string</source>
      <ExternalReference>string</ExternalReference>
      <LandTypeID>int</LandTypeID>
      <SLAID>int</SLAID>
      <CrewID>int</CrewID>
      <extendedData>
        <ServiceRequest_CreateServiceRequest_CreateFields>
          <FieldName xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldName>
          <FieldValue xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldValue>
          <Comments xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Comments>
        </ServiceRequest_CreateServiceRequest_CreateFields>
        <ServiceRequest_CreateServiceRequest_CreateFields>
          <FieldName xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldName>
          <FieldValue xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldValue>
          <Comments xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Comments>
        </ServiceRequest_CreateServiceRequest_CreateFields>
      </extendedData>
      <relatedServiceRequests>
        <ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
          <ServiceCode xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ServiceCode>
        </ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
        <ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
          <ServiceCode xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ServiceCode>
        </ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
      </relatedServiceRequests>
      <relatedPremises>
        <ServiceRequest_CreateServiceRequest_CreateLocation>
          <UPRN xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">decimal</UPRN>
        </ServiceRequest_CreateServiceRequest_CreateLocation>
        <ServiceRequest_CreateServiceRequest_CreateLocation>
          <UPRN xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">decimal</UPRN>
        </ServiceRequest_CreateServiceRequest_CreateLocation>
      </relatedPremises>
      <appointmentReservationID>int</appointmentReservationID>
    </ServiceRequest_Create>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ServiceRequest_CreateResponse xmlns="http://bartec-systems.com/">
      <ServiceRequest_CreateResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">
        <ServiceRequest_Create>
          <UPRN>decimal</UPRN>
          <ServiceLocation />
          <ServiceLocationDescription>string</ServiceLocationDescription>
          <DateRequested>dateTime</DateRequested>
          <ServiceTypeID>int</ServiceTypeID>
          <ServiceStatusID>int</ServiceStatusID>
          <ReporterContact>
            <Title>string</Title>
            <Forename>string</Forename>
            <OtherNames>string</OtherNames>
            <Surname>string</Surname>
            <Email>string</Email>
            <Telephone>string</Telephone>
            <Telephone2>string</Telephone2>
            <Telephone3>string</Telephone3>
            <SpecialCommunicationNeeds>string</SpecialCommunicationNeeds>
            <ExternalReference>string</ExternalReference>
            <ReporterType>string</ReporterType>
          </ReporterContact>
          <ReporterBusiness>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
            <ExternalReference>string</ExternalReference>
          </ReporterBusiness>
          <Source>string</Source>
          <ExternalReference>string</ExternalReference>
          <LandTypeID>int</LandTypeID>
          <SLAID>int</SLAID>
          <CrewID>int</CrewID>
          <ExtendedData>
            <Fields xsi:nil="true" />
            <Fields xsi:nil="true" />
          </ExtendedData>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
        </ServiceRequest_Create>
        <ServiceRequest_Create>
          <UPRN>decimal</UPRN>
          <ServiceLocation />
          <ServiceLocationDescription>string</ServiceLocationDescription>
          <DateRequested>dateTime</DateRequested>
          <ServiceTypeID>int</ServiceTypeID>
          <ServiceStatusID>int</ServiceStatusID>
          <ReporterContact>
            <Title>string</Title>
            <Forename>string</Forename>
            <OtherNames>string</OtherNames>
            <Surname>string</Surname>
            <Email>string</Email>
            <Telephone>string</Telephone>
            <Telephone2>string</Telephone2>
            <Telephone3>string</Telephone3>
            <SpecialCommunicationNeeds>string</SpecialCommunicationNeeds>
            <ExternalReference>string</ExternalReference>
            <ReporterType>string</ReporterType>
          </ReporterContact>
          <ReporterBusiness>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
            <ExternalReference>string</ExternalReference>
          </ReporterBusiness>
          <Source>string</Source>
          <ExternalReference>string</ExternalReference>
          <LandTypeID>int</LandTypeID>
          <SLAID>int</SLAID>
          <CrewID>int</CrewID>
          <ExtendedData>
            <Fields xsi:nil="true" />
            <Fields xsi:nil="true" />
          </ExtendedData>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
        </ServiceRequest_Create>
        <ServiceCode>string</ServiceCode>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </ServiceRequest_CreateResult>
    </ServiceRequest_CreateResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /API-R1604/CollectiveAPI.asmx HTTP/1.1
Host: collectiveapi.bartec-systems.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ServiceRequest_Create xmlns="http://bartec-systems.com/">
      <token>string</token>
      <UPRN>decimal</UPRN>
      <ServiceRequest_Location />
      <serviceLocationDescription>string</serviceLocationDescription>
      <DateRequested>dateTime</DateRequested>
      <ServiceTypeID>int</ServiceTypeID>
      <ServiceStatusID>int</ServiceStatusID>
      <reporterContact>
        <Title xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Title>
        <Forename xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Forename>
        <OtherNames xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</OtherNames>
        <Surname xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Surname>
        <Email xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Email>
        <Telephone xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Telephone>
        <Telephone2 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Telephone2>
        <Telephone3 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Telephone3>
        <SpecialCommunicationNeeds xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</SpecialCommunicationNeeds>
        <ExternalReference xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ExternalReference>
        <ReporterType xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ReporterType>
      </reporterContact>
      <reporterBusiness>
        <Name xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Name>
        <AddressLine1 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</AddressLine1>
        <AddressLine2 xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</AddressLine2>
        <Street xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Street>
        <Locality xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Locality>
        <Town xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Town>
        <PostCode xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</PostCode>
        <ExternalReference xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ExternalReference>
      </reporterBusiness>
      <source>string</source>
      <ExternalReference>string</ExternalReference>
      <LandTypeID>int</LandTypeID>
      <SLAID>int</SLAID>
      <CrewID>int</CrewID>
      <extendedData>
        <ServiceRequest_CreateServiceRequest_CreateFields>
          <FieldName xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldName>
          <FieldValue xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldValue>
          <Comments xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Comments>
        </ServiceRequest_CreateServiceRequest_CreateFields>
        <ServiceRequest_CreateServiceRequest_CreateFields>
          <FieldName xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldName>
          <FieldValue xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</FieldValue>
          <Comments xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</Comments>
        </ServiceRequest_CreateServiceRequest_CreateFields>
      </extendedData>
      <relatedServiceRequests>
        <ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
          <ServiceCode xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ServiceCode>
        </ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
        <ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
          <ServiceCode xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">string</ServiceCode>
        </ServiceRequest_CreateServiceRequest_CreateRelatedServiceRequest>
      </relatedServiceRequests>
      <relatedPremises>
        <ServiceRequest_CreateServiceRequest_CreateLocation>
          <UPRN xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">decimal</UPRN>
        </ServiceRequest_CreateServiceRequest_CreateLocation>
        <ServiceRequest_CreateServiceRequest_CreateLocation>
          <UPRN xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">decimal</UPRN>
        </ServiceRequest_CreateServiceRequest_CreateLocation>
      </relatedPremises>
      <appointmentReservationID>int</appointmentReservationID>
    </ServiceRequest_Create>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ServiceRequest_CreateResponse xmlns="http://bartec-systems.com/">
      <ServiceRequest_CreateResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequest_Create.xsd">
        <ServiceRequest_Create>
          <UPRN>decimal</UPRN>
          <ServiceLocation />
          <ServiceLocationDescription>string</ServiceLocationDescription>
          <DateRequested>dateTime</DateRequested>
          <ServiceTypeID>int</ServiceTypeID>
          <ServiceStatusID>int</ServiceStatusID>
          <ReporterContact>
            <Title>string</Title>
            <Forename>string</Forename>
            <OtherNames>string</OtherNames>
            <Surname>string</Surname>
            <Email>string</Email>
            <Telephone>string</Telephone>
            <Telephone2>string</Telephone2>
            <Telephone3>string</Telephone3>
            <SpecialCommunicationNeeds>string</SpecialCommunicationNeeds>
            <ExternalReference>string</ExternalReference>
            <ReporterType>string</ReporterType>
          </ReporterContact>
          <ReporterBusiness>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
            <ExternalReference>string</ExternalReference>
          </ReporterBusiness>
          <Source>string</Source>
          <ExternalReference>string</ExternalReference>
          <LandTypeID>int</LandTypeID>
          <SLAID>int</SLAID>
          <CrewID>int</CrewID>
          <ExtendedData>
            <Fields xsi:nil="true" />
            <Fields xsi:nil="true" />
          </ExtendedData>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
        </ServiceRequest_Create>
        <ServiceRequest_Create>
          <UPRN>decimal</UPRN>
          <ServiceLocation />
          <ServiceLocationDescription>string</ServiceLocationDescription>
          <DateRequested>dateTime</DateRequested>
          <ServiceTypeID>int</ServiceTypeID>
          <ServiceStatusID>int</ServiceStatusID>
          <ReporterContact>
            <Title>string</Title>
            <Forename>string</Forename>
            <OtherNames>string</OtherNames>
            <Surname>string</Surname>
            <Email>string</Email>
            <Telephone>string</Telephone>
            <Telephone2>string</Telephone2>
            <Telephone3>string</Telephone3>
            <SpecialCommunicationNeeds>string</SpecialCommunicationNeeds>
            <ExternalReference>string</ExternalReference>
            <ReporterType>string</ReporterType>
          </ReporterContact>
          <ReporterBusiness>
            <Name>string</Name>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <Street>string</Street>
            <Locality>string</Locality>
            <Town>string</Town>
            <PostCode>string</PostCode>
            <ExternalReference>string</ExternalReference>
          </ReporterBusiness>
          <Source>string</Source>
          <ExternalReference>string</ExternalReference>
          <LandTypeID>int</LandTypeID>
          <SLAID>int</SLAID>
          <CrewID>int</CrewID>
          <ExtendedData>
            <Fields xsi:nil="true" />
            <Fields xsi:nil="true" />
          </ExtendedData>
          <RelatedServiceRequests>
            <RelatedServiceRequest xsi:nil="true" />
            <RelatedServiceRequest xsi:nil="true" />
          </RelatedServiceRequests>
          <RelatedPremises>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </RelatedPremises>
        </ServiceRequest_Create>
        <ServiceCode>string</ServiceCode>
        <Errors>
          <Result xmlns="http://www.bartec-systems.com">int</Result>
          <Message xmlns="http://www.bartec-systems.com">string</Message>
        </Errors>
      </ServiceRequest_CreateResult>
    </ServiceRequest_CreateResponse>
  </soap12:Body>
</soap12:Envelope>