CollectiveAPIWebService
Click here for a complete list of operations.
ServiceRequests_Get
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/ServiceRequests_Get" <?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> <ServiceRequests_Get xmlns="http://bartec-systems.com/"> <token>string</token> <ServiceCode>string</ServiceCode> <ExternalRef>string</ExternalRef> <UPRNs> <decimal>decimal</decimal> <decimal>decimal</decimal> </UPRNs> <ContactName>string</ContactName> <ContactPhoneNo>string</ContactPhoneNo> <ContactEmail>string</ContactEmail> <PremisesBounds> <Point1 xmlns="http://www.bartec-systems.com" /> <Point2 xmlns="http://www.bartec-systems.com" /> </PremisesBounds> <RequestBounds> <Point1 xmlns="http://www.bartec-systems.com" /> <Point2 xmlns="http://www.bartec-systems.com" /> </RequestBounds> <RequestDate> <MinimumDate xmlns="http://www.bartec-systems.com">dateTime</MinimumDate> <MaximumDate xmlns="http://www.bartec-systems.com">dateTime</MaximumDate> </RequestDate> <ServiceTypes> <int>int</int> <int>int</int> </ServiceTypes> <LandTypes> <int>int</int> <int>int</int> </LandTypes> <ServiceStatuses> <int>int</int> <int>int</int> </ServiceStatuses> <Crews> <int>int</int> <int>int</int> </Crews> <SLAStatus>string</SLAStatus> <SLABreachTime> <MinimumDate xmlns="http://www.bartec-systems.com">dateTime</MinimumDate> <MaximumDate xmlns="http://www.bartec-systems.com">dateTime</MaximumDate> </SLABreachTime> </ServiceRequests_Get> </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> <ServiceRequests_GetResponse xmlns="http://bartec-systems.com/"> <ServiceRequests_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequests_Get.xsd"> <ServiceRequest> <id xmlns="http://www.bartec-systems.com">int</id> <ServiceCode xmlns="http://www.bartec-systems.com">string</ServiceCode> <Premises xmlns="http://www.bartec-systems.com"> <UPRN>decimal</UPRN> <USRN>decimal</USRN> <Address xsi:nil="true" /> <BLPUClassification xsi:nil="true" /> <BLPULogicalStatus xsi:nil="true" /> <UserLabel>string</UserLabel> <Ward xsi:nil="true" /> <Parish xsi:nil="true" /> <Location xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Premises> <Business xmlns="http://www.bartec-systems.com"> <ID>int</ID> <AccountNumber>string</AccountNumber> <AccountName>string</AccountName> <BusinessName>string</BusinessName> <BusinessDescription>string</BusinessDescription> <BusinessType xsi:nil="true" /> <BusinessStatus xsi:nil="true" /> <BusinessSubStatus xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Business> <Individual xmlns="http://www.bartec-systems.com"> <ID>int</ID> <PrimaryName>string</PrimaryName> <Email>string</Email> <Telephone>string</Telephone> <DateOfBirth>dateTime</DateOfBirth> <Deceased>boolean</Deceased> <DateDeceased>dateTime</DateDeceased> <RecordStamp xsi:nil="true" /> </Individual> <ServiceLocation xmlns="http://www.bartec-systems.com"> <BNG xsi:nil="true" /> <Metric xsi:nil="true" /> </ServiceLocation> <ServiceLocationDescription xmlns="http://www.bartec-systems.com">string</ServiceLocationDescription> <ReporterContact xmlns="http://www.bartec-systems.com"> <Title>string</Title> <Forename>string</Forename> <OtherNames>string</OtherNames> <Surname>string</Surname> <Email>string</Email> <Telephone>string</Telephone> <ExternalReference>string</ExternalReference> <ReporterType>string</ReporterType> </ReporterContact> <ReporterBusiness xmlns="http://www.bartec-systems.com"> <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> <DateRequested xmlns="http://www.bartec-systems.com">dateTime</DateRequested> <ServiceType xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Name>string</Name> <Description>string</Description> <AppointmentCount>int</AppointmentCount> <ServiceClass xsi:nil="true" /> <DefaultCrew xsi:nil="true" /> <DefaultLandType xsi:nil="true" /> <DefaultSLA xsi:nil="true" /> <RecordStamp xsi:nil="true" /> <ExtendedDataRecordDefinitionID>int</ExtendedDataRecordDefinitionID> </ServiceType> <ServiceStatus xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Status>string</Status> <SequenceNumber>integer</SequenceNumber> <ServiceTypeID>integer</ServiceTypeID> <RecordStamp xsi:nil="true" /> </ServiceStatus> <Source xmlns="http://www.bartec-systems.com">string</Source> <ExternalReference xmlns="http://www.bartec-systems.com">string</ExternalReference> <SLA xmlns="http://www.bartec-systems.com"> <SLAStatus>string</SLAStatus> <BreachTime>dateTime</BreachTime> <JeopardyTime>dateTime</JeopardyTime> </SLA> <ExtendedData xmlns="http://www.bartec-systems.com"> <Record xsi:nil="true" /> <Record xsi:nil="true" /> </ExtendedData> <LicenceApplication xmlns="http://www.bartec-systems.com"> <AccountReference>string</AccountReference> <Fee>decimal</Fee> <Deposit>decimal</Deposit> <PaymentType>string</PaymentType> <PaymentReference>string</PaymentReference> <LicenceNumber>string</LicenceNumber> <RequestDetails>string</RequestDetails> <WebPage>string</WebPage> <WebPageType>string</WebPageType> <FeeAdjustment>decimal</FeeAdjustment> </LicenceApplication> <RecordStamp xmlns="http://www.bartec-systems.com"> <AddedBy>string</AddedBy> <DateAdded>dateTime</DateAdded> <Comments>string</Comments> </RecordStamp> </ServiceRequest> <ServiceRequest> <id xmlns="http://www.bartec-systems.com">int</id> <ServiceCode xmlns="http://www.bartec-systems.com">string</ServiceCode> <Premises xmlns="http://www.bartec-systems.com"> <UPRN>decimal</UPRN> <USRN>decimal</USRN> <Address xsi:nil="true" /> <BLPUClassification xsi:nil="true" /> <BLPULogicalStatus xsi:nil="true" /> <UserLabel>string</UserLabel> <Ward xsi:nil="true" /> <Parish xsi:nil="true" /> <Location xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Premises> <Business xmlns="http://www.bartec-systems.com"> <ID>int</ID> <AccountNumber>string</AccountNumber> <AccountName>string</AccountName> <BusinessName>string</BusinessName> <BusinessDescription>string</BusinessDescription> <BusinessType xsi:nil="true" /> <BusinessStatus xsi:nil="true" /> <BusinessSubStatus xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Business> <Individual xmlns="http://www.bartec-systems.com"> <ID>int</ID> <PrimaryName>string</PrimaryName> <Email>string</Email> <Telephone>string</Telephone> <DateOfBirth>dateTime</DateOfBirth> <Deceased>boolean</Deceased> <DateDeceased>dateTime</DateDeceased> <RecordStamp xsi:nil="true" /> </Individual> <ServiceLocation xmlns="http://www.bartec-systems.com"> <BNG xsi:nil="true" /> <Metric xsi:nil="true" /> </ServiceLocation> <ServiceLocationDescription xmlns="http://www.bartec-systems.com">string</ServiceLocationDescription> <ReporterContact xmlns="http://www.bartec-systems.com"> <Title>string</Title> <Forename>string</Forename> <OtherNames>string</OtherNames> <Surname>string</Surname> <Email>string</Email> <Telephone>string</Telephone> <ExternalReference>string</ExternalReference> <ReporterType>string</ReporterType> </ReporterContact> <ReporterBusiness xmlns="http://www.bartec-systems.com"> <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> <DateRequested xmlns="http://www.bartec-systems.com">dateTime</DateRequested> <ServiceType xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Name>string</Name> <Description>string</Description> <AppointmentCount>int</AppointmentCount> <ServiceClass xsi:nil="true" /> <DefaultCrew xsi:nil="true" /> <DefaultLandType xsi:nil="true" /> <DefaultSLA xsi:nil="true" /> <RecordStamp xsi:nil="true" /> <ExtendedDataRecordDefinitionID>int</ExtendedDataRecordDefinitionID> </ServiceType> <ServiceStatus xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Status>string</Status> <SequenceNumber>integer</SequenceNumber> <ServiceTypeID>integer</ServiceTypeID> <RecordStamp xsi:nil="true" /> </ServiceStatus> <Source xmlns="http://www.bartec-systems.com">string</Source> <ExternalReference xmlns="http://www.bartec-systems.com">string</ExternalReference> <SLA xmlns="http://www.bartec-systems.com"> <SLAStatus>string</SLAStatus> <BreachTime>dateTime</BreachTime> <JeopardyTime>dateTime</JeopardyTime> </SLA> <ExtendedData xmlns="http://www.bartec-systems.com"> <Record xsi:nil="true" /> <Record xsi:nil="true" /> </ExtendedData> <LicenceApplication xmlns="http://www.bartec-systems.com"> <AccountReference>string</AccountReference> <Fee>decimal</Fee> <Deposit>decimal</Deposit> <PaymentType>string</PaymentType> <PaymentReference>string</PaymentReference> <LicenceNumber>string</LicenceNumber> <RequestDetails>string</RequestDetails> <WebPage>string</WebPage> <WebPageType>string</WebPageType> <FeeAdjustment>decimal</FeeAdjustment> </LicenceApplication> <RecordStamp xmlns="http://www.bartec-systems.com"> <AddedBy>string</AddedBy> <DateAdded>dateTime</DateAdded> <Comments>string</Comments> </RecordStamp> </ServiceRequest> <Errors> <Result xmlns="http://www.bartec-systems.com">int</Result> <Message xmlns="http://www.bartec-systems.com">string</Message> </Errors> </ServiceRequests_GetResult> </ServiceRequests_GetResponse> </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> <ServiceRequests_Get xmlns="http://bartec-systems.com/"> <token>string</token> <ServiceCode>string</ServiceCode> <ExternalRef>string</ExternalRef> <UPRNs> <decimal>decimal</decimal> <decimal>decimal</decimal> </UPRNs> <ContactName>string</ContactName> <ContactPhoneNo>string</ContactPhoneNo> <ContactEmail>string</ContactEmail> <PremisesBounds> <Point1 xmlns="http://www.bartec-systems.com" /> <Point2 xmlns="http://www.bartec-systems.com" /> </PremisesBounds> <RequestBounds> <Point1 xmlns="http://www.bartec-systems.com" /> <Point2 xmlns="http://www.bartec-systems.com" /> </RequestBounds> <RequestDate> <MinimumDate xmlns="http://www.bartec-systems.com">dateTime</MinimumDate> <MaximumDate xmlns="http://www.bartec-systems.com">dateTime</MaximumDate> </RequestDate> <ServiceTypes> <int>int</int> <int>int</int> </ServiceTypes> <LandTypes> <int>int</int> <int>int</int> </LandTypes> <ServiceStatuses> <int>int</int> <int>int</int> </ServiceStatuses> <Crews> <int>int</int> <int>int</int> </Crews> <SLAStatus>string</SLAStatus> <SLABreachTime> <MinimumDate xmlns="http://www.bartec-systems.com">dateTime</MinimumDate> <MaximumDate xmlns="http://www.bartec-systems.com">dateTime</MaximumDate> </SLABreachTime> </ServiceRequests_Get> </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> <ServiceRequests_GetResponse xmlns="http://bartec-systems.com/"> <ServiceRequests_GetResult RecordCount="int" xmlns="http://www.bartec-systems.com/ServiceRequests_Get.xsd"> <ServiceRequest> <id xmlns="http://www.bartec-systems.com">int</id> <ServiceCode xmlns="http://www.bartec-systems.com">string</ServiceCode> <Premises xmlns="http://www.bartec-systems.com"> <UPRN>decimal</UPRN> <USRN>decimal</USRN> <Address xsi:nil="true" /> <BLPUClassification xsi:nil="true" /> <BLPULogicalStatus xsi:nil="true" /> <UserLabel>string</UserLabel> <Ward xsi:nil="true" /> <Parish xsi:nil="true" /> <Location xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Premises> <Business xmlns="http://www.bartec-systems.com"> <ID>int</ID> <AccountNumber>string</AccountNumber> <AccountName>string</AccountName> <BusinessName>string</BusinessName> <BusinessDescription>string</BusinessDescription> <BusinessType xsi:nil="true" /> <BusinessStatus xsi:nil="true" /> <BusinessSubStatus xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Business> <Individual xmlns="http://www.bartec-systems.com"> <ID>int</ID> <PrimaryName>string</PrimaryName> <Email>string</Email> <Telephone>string</Telephone> <DateOfBirth>dateTime</DateOfBirth> <Deceased>boolean</Deceased> <DateDeceased>dateTime</DateDeceased> <RecordStamp xsi:nil="true" /> </Individual> <ServiceLocation xmlns="http://www.bartec-systems.com"> <BNG xsi:nil="true" /> <Metric xsi:nil="true" /> </ServiceLocation> <ServiceLocationDescription xmlns="http://www.bartec-systems.com">string</ServiceLocationDescription> <ReporterContact xmlns="http://www.bartec-systems.com"> <Title>string</Title> <Forename>string</Forename> <OtherNames>string</OtherNames> <Surname>string</Surname> <Email>string</Email> <Telephone>string</Telephone> <ExternalReference>string</ExternalReference> <ReporterType>string</ReporterType> </ReporterContact> <ReporterBusiness xmlns="http://www.bartec-systems.com"> <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> <DateRequested xmlns="http://www.bartec-systems.com">dateTime</DateRequested> <ServiceType xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Name>string</Name> <Description>string</Description> <AppointmentCount>int</AppointmentCount> <ServiceClass xsi:nil="true" /> <DefaultCrew xsi:nil="true" /> <DefaultLandType xsi:nil="true" /> <DefaultSLA xsi:nil="true" /> <RecordStamp xsi:nil="true" /> <ExtendedDataRecordDefinitionID>int</ExtendedDataRecordDefinitionID> </ServiceType> <ServiceStatus xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Status>string</Status> <SequenceNumber>integer</SequenceNumber> <ServiceTypeID>integer</ServiceTypeID> <RecordStamp xsi:nil="true" /> </ServiceStatus> <Source xmlns="http://www.bartec-systems.com">string</Source> <ExternalReference xmlns="http://www.bartec-systems.com">string</ExternalReference> <SLA xmlns="http://www.bartec-systems.com"> <SLAStatus>string</SLAStatus> <BreachTime>dateTime</BreachTime> <JeopardyTime>dateTime</JeopardyTime> </SLA> <ExtendedData xmlns="http://www.bartec-systems.com"> <Record xsi:nil="true" /> <Record xsi:nil="true" /> </ExtendedData> <LicenceApplication xmlns="http://www.bartec-systems.com"> <AccountReference>string</AccountReference> <Fee>decimal</Fee> <Deposit>decimal</Deposit> <PaymentType>string</PaymentType> <PaymentReference>string</PaymentReference> <LicenceNumber>string</LicenceNumber> <RequestDetails>string</RequestDetails> <WebPage>string</WebPage> <WebPageType>string</WebPageType> <FeeAdjustment>decimal</FeeAdjustment> </LicenceApplication> <RecordStamp xmlns="http://www.bartec-systems.com"> <AddedBy>string</AddedBy> <DateAdded>dateTime</DateAdded> <Comments>string</Comments> </RecordStamp> </ServiceRequest> <ServiceRequest> <id xmlns="http://www.bartec-systems.com">int</id> <ServiceCode xmlns="http://www.bartec-systems.com">string</ServiceCode> <Premises xmlns="http://www.bartec-systems.com"> <UPRN>decimal</UPRN> <USRN>decimal</USRN> <Address xsi:nil="true" /> <BLPUClassification xsi:nil="true" /> <BLPULogicalStatus xsi:nil="true" /> <UserLabel>string</UserLabel> <Ward xsi:nil="true" /> <Parish xsi:nil="true" /> <Location xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Premises> <Business xmlns="http://www.bartec-systems.com"> <ID>int</ID> <AccountNumber>string</AccountNumber> <AccountName>string</AccountName> <BusinessName>string</BusinessName> <BusinessDescription>string</BusinessDescription> <BusinessType xsi:nil="true" /> <BusinessStatus xsi:nil="true" /> <BusinessSubStatus xsi:nil="true" /> <RecordStamp xsi:nil="true" /> </Business> <Individual xmlns="http://www.bartec-systems.com"> <ID>int</ID> <PrimaryName>string</PrimaryName> <Email>string</Email> <Telephone>string</Telephone> <DateOfBirth>dateTime</DateOfBirth> <Deceased>boolean</Deceased> <DateDeceased>dateTime</DateDeceased> <RecordStamp xsi:nil="true" /> </Individual> <ServiceLocation xmlns="http://www.bartec-systems.com"> <BNG xsi:nil="true" /> <Metric xsi:nil="true" /> </ServiceLocation> <ServiceLocationDescription xmlns="http://www.bartec-systems.com">string</ServiceLocationDescription> <ReporterContact xmlns="http://www.bartec-systems.com"> <Title>string</Title> <Forename>string</Forename> <OtherNames>string</OtherNames> <Surname>string</Surname> <Email>string</Email> <Telephone>string</Telephone> <ExternalReference>string</ExternalReference> <ReporterType>string</ReporterType> </ReporterContact> <ReporterBusiness xmlns="http://www.bartec-systems.com"> <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> <DateRequested xmlns="http://www.bartec-systems.com">dateTime</DateRequested> <ServiceType xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Name>string</Name> <Description>string</Description> <AppointmentCount>int</AppointmentCount> <ServiceClass xsi:nil="true" /> <DefaultCrew xsi:nil="true" /> <DefaultLandType xsi:nil="true" /> <DefaultSLA xsi:nil="true" /> <RecordStamp xsi:nil="true" /> <ExtendedDataRecordDefinitionID>int</ExtendedDataRecordDefinitionID> </ServiceType> <ServiceStatus xmlns="http://www.bartec-systems.com"> <ID>int</ID> <Status>string</Status> <SequenceNumber>integer</SequenceNumber> <ServiceTypeID>integer</ServiceTypeID> <RecordStamp xsi:nil="true" /> </ServiceStatus> <Source xmlns="http://www.bartec-systems.com">string</Source> <ExternalReference xmlns="http://www.bartec-systems.com">string</ExternalReference> <SLA xmlns="http://www.bartec-systems.com"> <SLAStatus>string</SLAStatus> <BreachTime>dateTime</BreachTime> <JeopardyTime>dateTime</JeopardyTime> </SLA> <ExtendedData xmlns="http://www.bartec-systems.com"> <Record xsi:nil="true" /> <Record xsi:nil="true" /> </ExtendedData> <LicenceApplication xmlns="http://www.bartec-systems.com"> <AccountReference>string</AccountReference> <Fee>decimal</Fee> <Deposit>decimal</Deposit> <PaymentType>string</PaymentType> <PaymentReference>string</PaymentReference> <LicenceNumber>string</LicenceNumber> <RequestDetails>string</RequestDetails> <WebPage>string</WebPage> <WebPageType>string</WebPageType> <FeeAdjustment>decimal</FeeAdjustment> </LicenceApplication> <RecordStamp xmlns="http://www.bartec-systems.com"> <AddedBy>string</AddedBy> <DateAdded>dateTime</DateAdded> <Comments>string</Comments> </RecordStamp> </ServiceRequest> <Errors> <Result xmlns="http://www.bartec-systems.com">int</Result> <Message xmlns="http://www.bartec-systems.com">string</Message> </Errors> </ServiceRequests_GetResult> </ServiceRequests_GetResponse> </soap12:Body> </soap12:Envelope>