ParksEapplyService Web Service

ParksEapplyService

Click here for a complete list of operations.

GetUserPermits

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 /parkswebservice/DprEapplyService.asmx HTTP/1.1
Host: a002-pservice.nyc.gov
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://nycparkspermits.nyc.gov1/GetUserPermits"

<?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:Header>
    <RequestCredentials xmlns="http://nycparkspermits.nyc.gov1/">
      <Key>string</Key>
      <ServiceAccount>string</ServiceAccount>
    </RequestCredentials>
  </soap:Header>
  <soap:Body>
    <GetUserPermits xmlns="http://nycparkspermits.nyc.gov1/">
      <userId>guid</userId>
    </GetUserPermits>
  </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>
    <GetUserPermitsResponse xmlns="http://nycparkspermits.nyc.gov1/">
      <GetUserPermitsResult>
        <RequestResponse>
          <Result>string</Result>
          <HasErrors>boolean</HasErrors>
          <ReturnedErrorCode>string</ReturnedErrorCode>
          <ReturnedErrorMessage>string</ReturnedErrorMessage>
        </RequestResponse>
        <SubmittedPermits>
          <SubmittedEventObj>
            <UserEventId>int</UserEventId>
            <EventId>int</EventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <SubmittedDate>dateTime</SubmittedDate>
            <Notify>boolean</Notify>
            <Response>boolean</Response>
            <OrderNumber>string</OrderNumber>
            <Renewable>boolean</Renewable>
            <AccountHold>boolean</AccountHold>
            <NonCopyable>boolean</NonCopyable>
            <Copyable>boolean</Copyable>
            <AgencyEventId>string</AgencyEventId>
            <Locations xsi:nil="true" />
            <StatusHistory xsi:nil="true" />
          </SubmittedEventObj>
          <SubmittedEventObj>
            <UserEventId>int</UserEventId>
            <EventId>int</EventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <SubmittedDate>dateTime</SubmittedDate>
            <Notify>boolean</Notify>
            <Response>boolean</Response>
            <OrderNumber>string</OrderNumber>
            <Renewable>boolean</Renewable>
            <AccountHold>boolean</AccountHold>
            <NonCopyable>boolean</NonCopyable>
            <Copyable>boolean</Copyable>
            <AgencyEventId>string</AgencyEventId>
            <Locations xsi:nil="true" />
            <StatusHistory xsi:nil="true" />
          </SubmittedEventObj>
        </SubmittedPermits>
        <SavedPermits>
          <SavedEventObj>
            <UserEventId>int</UserEventId>
            <AgencyEventId>string</AgencyEventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <CreatedDate>dateTime</CreatedDate>
            <CompletedStep>int</CompletedStep>
          </SavedEventObj>
          <SavedEventObj>
            <UserEventId>int</UserEventId>
            <AgencyEventId>string</AgencyEventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <CreatedDate>dateTime</CreatedDate>
            <CompletedStep>int</CompletedStep>
          </SavedEventObj>
        </SavedPermits>
      </GetUserPermitsResult>
    </GetUserPermitsResponse>
  </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 /parkswebservice/DprEapplyService.asmx HTTP/1.1
Host: a002-pservice.nyc.gov
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:Header>
    <RequestCredentials xmlns="http://nycparkspermits.nyc.gov1/">
      <Key>string</Key>
      <ServiceAccount>string</ServiceAccount>
    </RequestCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetUserPermits xmlns="http://nycparkspermits.nyc.gov1/">
      <userId>guid</userId>
    </GetUserPermits>
  </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>
    <GetUserPermitsResponse xmlns="http://nycparkspermits.nyc.gov1/">
      <GetUserPermitsResult>
        <RequestResponse>
          <Result>string</Result>
          <HasErrors>boolean</HasErrors>
          <ReturnedErrorCode>string</ReturnedErrorCode>
          <ReturnedErrorMessage>string</ReturnedErrorMessage>
        </RequestResponse>
        <SubmittedPermits>
          <SubmittedEventObj>
            <UserEventId>int</UserEventId>
            <EventId>int</EventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <SubmittedDate>dateTime</SubmittedDate>
            <Notify>boolean</Notify>
            <Response>boolean</Response>
            <OrderNumber>string</OrderNumber>
            <Renewable>boolean</Renewable>
            <AccountHold>boolean</AccountHold>
            <NonCopyable>boolean</NonCopyable>
            <Copyable>boolean</Copyable>
            <AgencyEventId>string</AgencyEventId>
            <Locations xsi:nil="true" />
            <StatusHistory xsi:nil="true" />
          </SubmittedEventObj>
          <SubmittedEventObj>
            <UserEventId>int</UserEventId>
            <EventId>int</EventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <SubmittedDate>dateTime</SubmittedDate>
            <Notify>boolean</Notify>
            <Response>boolean</Response>
            <OrderNumber>string</OrderNumber>
            <Renewable>boolean</Renewable>
            <AccountHold>boolean</AccountHold>
            <NonCopyable>boolean</NonCopyable>
            <Copyable>boolean</Copyable>
            <AgencyEventId>string</AgencyEventId>
            <Locations xsi:nil="true" />
            <StatusHistory xsi:nil="true" />
          </SubmittedEventObj>
        </SubmittedPermits>
        <SavedPermits>
          <SavedEventObj>
            <UserEventId>int</UserEventId>
            <AgencyEventId>string</AgencyEventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <CreatedDate>dateTime</CreatedDate>
            <CompletedStep>int</CompletedStep>
          </SavedEventObj>
          <SavedEventObj>
            <UserEventId>int</UserEventId>
            <AgencyEventId>string</AgencyEventId>
            <EventName>string</EventName>
            <EventStartDate>dateTime</EventStartDate>
            <EventSetupStartDate>dateTime</EventSetupStartDate>
            <EventEndDate>dateTime</EventEndDate>
            <EventBreakDownEndDate>dateTime</EventBreakDownEndDate>
            <EventType>string</EventType>
            <StatusId>int</StatusId>
            <Status>string</Status>
            <CreatedDate>dateTime</CreatedDate>
            <CompletedStep>int</CompletedStep>
          </SavedEventObj>
        </SavedPermits>
      </GetUserPermitsResult>
    </GetUserPermitsResponse>
  </soap12:Body>
</soap12:Envelope>