TicketUserServices

<back to all web services

LocationsSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/Locations

export class Location
{
    public id?: number;
    public name?: string;
    public latitude?: number;
    public longitude?: number;
    public addressName?: string;
    public addressLine?: string;
    public zip?: string;
    public city?: string;
    public county?: string;
    public stateCode?: string;
    public stateName?: string;
    public countryCode?: string;
    public countryName?: string;
    public timeZone?: string;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class LocationsResult
{
    public items?: Location[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<LocationsResult>) { (Object as any).assign(this, init); }
}

export class LocationsSearchRequest
{
    public name?: string;
    public countryCode?: string;

    public constructor(init?: Partial<LocationsSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript LocationsSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Locations HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LocationsSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CountryCode>String</CountryCode>
  <Name>String</Name>
</LocationsSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LocationsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:Location>
      <d2p1:AddressLine>String</d2p1:AddressLine>
      <d2p1:AddressName>String</d2p1:AddressName>
      <d2p1:City>String</d2p1:City>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:CountryName>String</d2p1:CountryName>
      <d2p1:County>String</d2p1:County>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:StateCode>String</d2p1:StateCode>
      <d2p1:StateName>String</d2p1:StateName>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:Zip>String</d2p1:Zip>
    </d2p1:Location>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</LocationsResult>