GetJobs

Retrieve the Jobs employees can clock in under for this location.

Note: We recommend using Settings2.svc for the GetJobs call as this is deprecated in Settings.svc.

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Success
- 1 — Unknown Error
- 3 — Server Unavailable
- 4 — Access Denied
Jobs Array of Job — Array of Job objects for this location.
Job Properties
- Id int — Unique Id of this Job
- JobUniqueId Guid — Unique identifier of this Job
- Name string — Name of this Job

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetJobs request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetJobs

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetJobs' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetJobs"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetJobs>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetJobs>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetJobsResponse xmlns="http://tempuri.org/">
      <Settings_GetJobsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Jobs>
          <Job>
            <Id>3</Id>
            <JobUniqueId>a1b2c3d4-e5f6-7890-abcd-ef1234567890</JobUniqueId>
            <Name>Server</Name>
          </Job>
        </Jobs>
      </Settings_GetJobsResult>
    </Settings_GetJobsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Job objects.