Registrar Web Services

<back to all web services

R_PublicStateProvinces

The following routes are available for this service:
GET, OPTIONS/UserApi/R_StateProvinces
GET, OPTIONS/UserApi/R_StateProvinces/{Ids}
GET, OPTIONS/UserApi/R_CountryRegions/{CountryCodes}/R_StateProvinces
R_PublicStateProvinces Parameters:
NameParameterData TypeRequiredDescription
CountryCodespathList<string>No
IdspathList<long>No

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 /xml/reply/R_PublicStateProvinces HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_PublicStateProvinces xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <CountryCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CountryCodes>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
</R_PublicStateProvinces>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_StateProvince xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_StateProvince>
    <Code>String</Code>
    <CountryCode>String</CountryCode>
    <Id>0</Id>
    <StateProvinceCode>String</StateProvinceCode>
    <StateProvinceName>String</StateProvinceName>
  </R_StateProvince>
</ArrayOfR_StateProvince>