Xerox Public Print API Documentation

Versions

Here you will find documentation relative to the Xerox Public Print API. You can view additional information by clicking the method below.

Security

It is required, for all secure calls, that the xrxauth, user-email, and appid headers be provided with the appropriate values.
If user-email is not provided, the API will treat the request as an "application" request.
Failure to do so will result in a "BadRequest" response.

Response Headers

When creating a new resource, the response header Resource-ID will be populated with the new resource id.
In some cases, the API will return specific response headers with helpful URI's.

v1

[PUT] api/v1/Job/

Description

Creates a new job. This method returns the following response headers:

Resource-Id - the new job id.
Details-Uri - the uri to obtain details on the new job.
Status-Uri - the uri to obtain the status of the new job.

Parameter(s)

The job to be created.

Sample

{
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4",
    "sample string 5": "sample string 6"
  },
  "SiteId": "0be5f9f2-99ad-41d5-b1b7-29140cfbf9d8",
  "DocumentId": "sample string 2",
  "SpecialInstructions": "sample string 3",
  "IsPickupReady": true,
  "PickupDateTime": "2024-11-22T17:36:28.6795279+00:00",
  "DocumentName": "sample string 5"
}

Returns

Response will not contain content.

[GET] api/v1/Job?id={id}

Description

Gets the details of a job.

Parameter(s)

(FromUri) Guid id - The job id.

Sample: "dba9f760-cbf5-4134-bdbd-8d271947ae5e"

Returns

JobDetailsRepresentation

Boolean Completed
String ConfirmationCode
String CreatedBy
DateTime CreatedDate
String Destination
Nullable<Guid> DeviceId
String DocumentId
String DocumentName
Nullable<DateTime> ExpirationDate
Boolean Failed
String Href
Guid ID
Boolean IsDeleted
Boolean IsPickupReady
String LinkName
IList<Link> Links
String ModifiedBy
DateTime ModifiedDate
IEnumerable<IJobOptionDetails> Options
Nullable<DateTime> PickupDate
String ProviderInformation
String Rel
Nullable<Guid> SiteId
String SpecialInstructions
String Status
IJobResourceUris SubResourceUris
Guid UserId

Sample

{
  "Completed": true,
  "ConfirmationCode": "sample string 2",
  "Destination": "sample string 3",
  "ExpirationDate": "2024-11-22T17:36:28.6795279+00:00",
  "Failed": true,
  "Options": null,
  "Status": "sample string 5",
  "SubResourceUris": null,
  "CreatedBy": "sample string 6",
  "CreatedDate": "2024-11-22T17:36:28.6795279+00:00",
  "DeviceId": "eddc0f30-80a2-4afa-b27e-0094ef624d48",
  "DocumentId": "sample string 8",
  "DocumentName": "sample string 9",
  "ID": "4499f0f8-16c2-47ca-b17a-cfe909621ee8",
  "IsDeleted": true,
  "IsPickupReady": true,
  "ModifiedBy": "sample string 13",
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00",
  "PickupDate": "2024-11-22T17:36:28.6795279+00:00",
  "SiteId": "a3f80895-b7c7-49a8-8ee5-4b126829e523",
  "SpecialInstructions": "sample string 15",
  "ProviderInformation": "sample string 16",
  "UserId": "f04804ed-e820-486d-8b2a-6fde273f539c",
  "_links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    }
  ]
}

[GET] api/v1/Job/History?$skip={$skip}&$take={$take}

Description

Gets the public print history for the current user.

Parameter(s)

(FromUri) Int32 $skip - The number of records to skip. (Page)

Sample: 1

(FromUri) Int32 $take - The number of records to take. (Page Size)

Sample: 1

Returns

JobHistoryListRepresentation

String Href
JobHistoryRepresentation Item
JobHistoryRepresentation Item
String LinkName
IList<Link> Links
String Rel

Element Type: JobHistoryRepresentation

Boolean Completed
String Destination
Nullable<Guid> DeviceId
String DocumentId
String DocumentName
DateTime ExpirationDate
Boolean HasConfirmationCode
String Href
Guid ID
String LinkName
IList<Link> Links
Double Progress
Guid ProviderTypeId
String Rel
Guid SiteId
String Status
DateTime SubmissionDate
IJobHistoryResourceUris SubResourceUris

Sample

[
  {
    "Completed": true,
    "Destination": "sample string 2",
    "DeviceId": "4cf59d08-60e0-45f1-95be-f11193857355",
    "DocumentId": "sample string 3",
    "DocumentName": "sample string 4",
    "ExpirationDate": "2024-11-22T17:36:28.6795279+00:00",
    "HasConfirmationCode": true,
    "ID": "c9ce1dc6-fbcd-4380-859d-60d0de25cf8a",
    "JobStatus": "sample string 8",
    "ProviderTypeId": "610cdcb5-7216-4a6f-be11-d6b91f1c4387",
    "SiteId": "752b1e6c-2d28-4e52-8a1f-1374a19be8a3",
    "SubResourceUris": null,
    "SubmissionDate": "2024-11-22T17:36:28.6795279+00:00",
    "Progress": 12.1,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Completed": true,
    "Destination": "sample string 2",
    "DeviceId": "3bd944dc-fc02-4f38-8504-81eb86e73206",
    "DocumentId": "sample string 3",
    "DocumentName": "sample string 4",
    "ExpirationDate": "2024-11-22T17:36:28.6795279+00:00",
    "HasConfirmationCode": true,
    "ID": "75b1582b-c2d2-419c-b861-b23b893f3141",
    "JobStatus": "sample string 8",
    "ProviderTypeId": "587601ef-101c-4b0e-ab16-3943b9db87e3",
    "SiteId": "5ee47b94-aa20-420f-ba81-42a6b407dfcb",
    "SubResourceUris": null,
    "SubmissionDate": "2024-11-22T17:36:28.6795279+00:00",
    "Progress": 12.1,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Completed": true,
    "Destination": "sample string 2",
    "DeviceId": "19158f5e-8124-4189-861d-c12b53ccc049",
    "DocumentId": "sample string 3",
    "DocumentName": "sample string 4",
    "ExpirationDate": "2024-11-22T17:36:28.6795279+00:00",
    "HasConfirmationCode": true,
    "ID": "85c6bab2-382b-4d6f-be5b-e121edbf4e3e",
    "JobStatus": "sample string 8",
    "ProviderTypeId": "5cfc14c7-f504-4bcc-8065-9773febcf9bf",
    "SiteId": "40079c48-bf5d-469d-8a14-e799f259a75a",
    "SubResourceUris": null,
    "SubmissionDate": "2024-11-22T17:36:28.6795279+00:00",
    "Progress": 12.1,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  }
]

[DELETE] api/v1/Job/History

Description

Clears the job history for the current user

Returns

Response will not contain content.

[GET] api/v1/Job/Status?jobId={jobId}

Description

Gets the status of a job.

Parameter(s)

(FromUri) Guid jobId - The job id.

Sample: "bbb6b088-b729-4b4a-8614-7482f4b64398"

Returns

JobStatusRepresentation

Boolean Completed
String ConfirmationCode
DateTime CreatedDate
String DocumentId
Nullable<DateTime> ExpirationDate
Boolean Failed
String Href
Boolean IsDeleted
Guid JobId
String LinkName
IList<Link> Links
DateTime ModifiedDate
Double Progress
Guid ProviderTypeId
String Rel
String Status

Sample

{
  "Completed": true,
  "ConfirmationCode": "sample string 2",
  "CreatedDate": "2024-11-22T17:36:28.6795279+00:00",
  "Failed": true,
  "IsDeleted": true,
  "JobId": "8cc3f9f5-b0d2-4372-ad9f-fed03186406d",
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00",
  "Status": "sample string 8",
  "ExpirationDate": "2024-11-22T17:36:28.6795279+00:00",
  "Progress": 9.1,
  "DocumentId": "sample string 10",
  "ProviderTypeId": "4d47f014-f12b-45ee-8b70-98868ebbe10b",
  "_links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    }
  ]
}

[POST] api/v1/Job/Status

Description

Updates the status of a job.

Parameter(s)

The new job status.

Sample

{
  "JobId": "1401f442-3eb2-4318-a786-45c7bfbb9c59",
  "ConfirmationCode": "sample string 2",
  "Status": "sample string 3",
  "Completed": true,
  "Failed": true,
  "CreatedDate": "2024-11-22T17:36:28.6795279+00:00",
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00",
  "IsDeleted": true,
  "ExpirationDate": "2024-11-22T17:36:28.6795279+00:00"
}

Returns

Response will not contain content.

[GET] api/v1/Job/Options

Description

Gets the entire list of options supported by the system. These are the supported values for use when creating a job.

Returns

IEnumerable<Option>

Sample

[
  {
    "Name": "sample string 1",
    "DisplayName": "sample string 2",
    "ID": "a99f44dd-e72c-4503-8e5e-08edcee2c62b"
  },
  {
    "Name": "sample string 1",
    "DisplayName": "sample string 2",
    "ID": "a99f44dd-e72c-4503-8e5e-08edcee2c62b"
  },
  {
    "Name": "sample string 1",
    "DisplayName": "sample string 2",
    "ID": "a99f44dd-e72c-4503-8e5e-08edcee2c62b"
  }
]

[GET] api/v1/EULA?providerId={providerId}
Description

Gets the EULA for the specified Provider. This method returns the following response headers:
- Agree-Uri - the uri to agree to the EULA.
Parameter(s)
(FromUri) Guid providerId - The provider id.
```
Sample: "e3c5b46a-0fd8-4bd7-89ff-1812adbcabf4"
```
Returns

Response will not contain content.

[POST] api/v1/EULA/

Description

Inserts or Updates a EULA for the specified provider.

Parameter(s)

The EULA.

Sample

{
  "ProviderId": "c45382c8-fe4f-4cc4-912b-5595a5b38890",
  "BlobContainerName": "sample string 2",
  "Version": "sample string 3",
  "CulturedTextMap": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4",
    "sample string 5": "sample string 6"
  }
}

Returns

Response will not contain content.

[PUT] api/v1/EULA/Agree?providerId={providerId}
Description

Agrees to the EULA for the specified Provider

Parameter(s)
(FromUri) Guid providerId - The provider id.
```
Sample: "edce145b-5080-4dba-a7d3-df76cbb05a6e"
```
Returns

Response will not contain content.
[GET] api/v1/Status/

Description

Gets the status. This is used for monitoring purposes.

Returns

Response will not contain content.

[GET] api/v1/ProviderTypes?$skip={$skip}&$take={$take}

Description

Gets all of the provider types supported by the system.

Parameter(s)

(FromUri) Int32 $skip - No Documentation Found.

Sample: 1

(FromUri) Int32 $take - No Documentation Found.

Sample: 1

Returns

ProviderTypeListRepresentation

String Href
ProviderTypeRepresentation Item
ProviderTypeRepresentation Item
String LinkName
IList<Link> Links
String Rel

Element Type: ProviderTypeRepresentation

String DisplayName
String Href
Guid ID
String LinkName
IList<Link> Links
String Name
String Rel

Sample

[
  {
    "DisplayName": "sample string 1",
    "ID": "bd110e44-67ad-4d7d-b643-f4d2f50bd384",
    "Name": "sample string 3",
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "DisplayName": "sample string 1",
    "ID": "735bf85f-dc0a-4a51-9e60-87bf52db26df",
    "Name": "sample string 3",
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "DisplayName": "sample string 1",
    "ID": "ca9dad2b-b41b-483f-a2ac-99548522ff9c",
    "Name": "sample string 3",
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  }
]

[PUT] api/v1/ProviderTypes/
Description

Creates the specified provider type.

Parameter(s)
The provider type to create.

Sample
```
{
  "ID": "fb71e6f8-4af8-43ce-959c-95e18d513529",
  "Name": "sample string 2",
  "DisplayName": "sample string 3",
  "AllowGPSSearch": true
}
```
Returns

Response will not contain content.

[GET] api/v1/Sites?id={id}&filterDeleted={filterDeleted}

Description

Gets the details of a site based on the id specified.

Parameter(s)

(FromUri) Guid id - The site id.

Sample: "3f9446b2-f7ea-43d9-9419-3ad5cd07b58f"

(FromUri) Boolean filterDeleted - true if not interested in deleted sites.

Sample: true

Returns

SiteDetailsRepresentation

String Address
String Address2
String Address3
ICollection<IOption> Capabilities
String City
String Country
String CurrencySymbol
SqlGeography GeoLocation
ICollection<IBusinessHours> Hours
String Href
Guid ID
Boolean IsDeleted
Boolean IsFavorite
Double Latitude
String LinkName
IList<Link> Links
Double Longitude
DateTime ModifiedDate
String Name
String PhoneNumber
String PostalCode
ICollection<IOptionPrice> Pricing
Guid ProviderId
String ProviderLogoUrl
String ProviderName
String Rel
String RemoteId
String SiteType
String StateProvince
SiteSubResourceUri SubResourceUris

Sample

{
  "Capabilities": null,
  "Hours": null,
  "Latitude": 0.0,
  "Longitude": 0.0,
  "Pricing": null,
  "ProviderLogoUrl": "sample string 1",
  "ProviderName": "sample string 2",
  "Address": "sample string 3",
  "Address2": "sample string 4",
  "Address3": "sample string 5",
  "City": "sample string 6",
  "Country": "sample string 7",
  "CurrencySymbol": "sample string 8",
  "ID": "fbb14bd7-eeef-40f7-98b0-f515805987b0",
  "IsDeleted": true,
  "Name": "sample string 12",
  "PhoneNumber": "sample string 13",
  "PostalCode": "sample string 14",
  "ProviderId": "2f7d7235-fd65-4678-ae35-7cb6b84dde44",
  "RemoteId": "sample string 16",
  "SiteType": "sample string 17",
  "StateProvince": "sample string 18",
  "IsFavorite": true,
  "SubResourceUris": {
    "EULA": "sample string 1"
  },
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00",
  "_links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    }
  ]
}

[PUT] api/v1/Sites/

Description

Creates a new site.

Parameter(s)

The site to create.

Sample

{
  "GeoLocation": {
    "Latitude": 0.0,
    "Longitude": 0.0
  },
  "Options": [
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "ID": "4d2fd1c9-5631-466e-8f09-6fd9d511b488"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "ID": "4d2fd1c9-5631-466e-8f09-6fd9d511b488"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "ID": "4d2fd1c9-5631-466e-8f09-6fd9d511b488"
    }
  ],
  "ID": "ca91ba5f-7a01-4657-82d5-a4f05e2be01a",
  "ProviderId": "1b1ef618-9a20-4f66-8194-250d333f91b5",
  "Address": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "City": "sample string 7",
  "StateProvince": "sample string 8",
  "PostalCode": "sample string 9",
  "Country": "sample string 10",
  "PhoneNumber": "sample string 11",
  "CurrencySymbol": "sample string 12",
  "SiteType": "sample string 13",
  "Name": "sample string 14",
  "RemoteId": "sample string 15",
  "IsDeleted": true,
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00"
}

Returns

Response will not contain content.

[POST] api/v1/Sites/

Description

Updates an existing site.

Parameter(s)

The site to update.

Sample

{
  "GeoLocation": {
    "Latitude": 0.0,
    "Longitude": 0.0
  },
  "Options": [
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "ID": "2ee538b8-d3ac-4796-8b92-7afba919efd0"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "ID": "2ee538b8-d3ac-4796-8b92-7afba919efd0"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "ID": "2ee538b8-d3ac-4796-8b92-7afba919efd0"
    }
  ],
  "ID": "f7445556-fd83-4671-afa2-7e2d62c0fd4d",
  "ProviderId": "5c0d6eb6-69c7-4653-b06f-8b41ef27571b",
  "Address": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "City": "sample string 7",
  "StateProvince": "sample string 8",
  "PostalCode": "sample string 9",
  "Country": "sample string 10",
  "PhoneNumber": "sample string 11",
  "CurrencySymbol": "sample string 12",
  "SiteType": "sample string 13",
  "Name": "sample string 14",
  "RemoteId": "sample string 15",
  "IsDeleted": true,
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00"
}

Returns

Response will not contain content.

[DELETE] api/v1/Sites/
Description

Deletes the specified site.

Parameter(s)
The id of the site to delete.

Sample
```
"9b96c083-e54e-4318-9f2d-9f6e0164bd4b"
```
Returns

Response will not contain content.

[GET] api/v1/Sites/Search?longitude={longitude}&latitude={latitude}&range={range}&providerId={providerId}&$skip={$skip}&$take={$take}

Description

Searches for sites matching the specified criteria.

Parameter(s)

(FromUri) Double longitude - The longitude.

Sample: 1.1

(FromUri) Double latitude - The latitude.

Sample: 1.1

(FromUri) Double range - The range.

Sample: 1.1

(FromUri) DistanceUnit distanceUnit - The distance unit.

Sample: Miles

(FromUri) Nullable<Guid>

Boolean HasValue
Guid Value

providerId - The provider id.

Sample: "86f712b6-6f3c-404e-af94-3cd7f176ed61"

(FromUri) Int32 $skip - The skip.

Sample: 1

(FromUri) Int32 $take - The take.

Sample: 1

Returns

SiteSearchResultListRepresentation

String Href
SiteSearchResultRepresentation Item
SiteSearchResultRepresentation Item
String LinkName
IList<Link> Links
String Rel

Element Type: SiteSearchResultRepresentation

String Address
String City
String Href
Guid ID
Boolean IsFavorite
Double Latitude
String LinkName
IList<Link> Links
Double Longitude
String PostalCode
Guid ProviderId
String ProviderLogoUrl
String ProviderName
String Rel
String RemoteId
String SiteName
String SiteType
String StateProvince

Sample

[
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "40ccbd92-c2f7-49be-ac3f-d55727103982",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "8ceb5c7a-ae77-45f1-bcd1-57b310c55568",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "978686a6-f558-4486-bf9b-763141abd378",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "89126f67-fcfe-47d0-927e-995ec13562a4",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "b8818d7d-268f-46e1-9bfd-c75913ac99b1",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "cda7bb2a-21f7-4e1e-b01c-e398f6cb369b",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  }
]

[GET] api/v1/Sites/SearchByName?filter={filter}&longitude={longitude}&latitude={latitude}&$skip={$skip}&$take={$take}

Description

Searches for sites matching the specified name criteria.

Parameter(s)

(FromUri) String

Char Chars
Int32 Length

Element Type: Char

filter - The filter that sites name should match.

Sample: "sample string 1"

(FromUri) Double longitude - The longitude.

Sample: 1.1

(FromUri) Double latitude - The latitude.

Sample: 1.1

(FromUri) Int32 $skip - The skip.

Sample: 1

(FromUri) Int32 $take - The take.

Sample: 1

Returns

SiteSearchResultListRepresentation

String Href
SiteSearchResultRepresentation Item
SiteSearchResultRepresentation Item
String LinkName
IList<Link> Links
String Rel

Element Type: SiteSearchResultRepresentation

String Address
String City
String Href
Guid ID
Boolean IsFavorite
Double Latitude
String LinkName
IList<Link> Links
Double Longitude
String PostalCode
Guid ProviderId
String ProviderLogoUrl
String ProviderName
String Rel
String RemoteId
String SiteName
String SiteType
String StateProvince

Sample

[
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "26298291-dcc6-407c-bb04-b8e3e148e44d",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "67d8cb76-e248-4fbe-a8b8-f1b20ab5f79d",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "e809b6a5-244d-4faf-812e-eae7c86a7161",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "942f6d32-4f29-4b64-8672-7d49e1dd5bb3",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "463eba09-5c59-4b46-abfa-6f19769d4998",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "bdd40fb6-ee4c-4f31-9c43-41eb57a63d17",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  }
]

[GET] api/v1/Sites/SearchByRemoteId?remoteId={remoteId}

Description

Searches for the site matching the given remote id.

Parameter(s)

(FromUri) String

Char Chars
Int32 Length

Element Type: Char

remoteId - The id of the site in its remote system (CP,EFI)

Sample: "sample string 1"

Returns

SiteDetailsRepresentation

String Address
String Address2
String Address3
ICollection<IOption> Capabilities
String City
String Country
String CurrencySymbol
SqlGeography GeoLocation
ICollection<IBusinessHours> Hours
String Href
Guid ID
Boolean IsDeleted
Boolean IsFavorite
Double Latitude
String LinkName
IList<Link> Links
Double Longitude
DateTime ModifiedDate
String Name
String PhoneNumber
String PostalCode
ICollection<IOptionPrice> Pricing
Guid ProviderId
String ProviderLogoUrl
String ProviderName
String Rel
String RemoteId
String SiteType
String StateProvince
SiteSubResourceUri SubResourceUris

Sample

{
  "Capabilities": null,
  "Hours": null,
  "Latitude": 0.0,
  "Longitude": 0.0,
  "Pricing": null,
  "ProviderLogoUrl": "sample string 1",
  "ProviderName": "sample string 2",
  "Address": "sample string 3",
  "Address2": "sample string 4",
  "Address3": "sample string 5",
  "City": "sample string 6",
  "Country": "sample string 7",
  "CurrencySymbol": "sample string 8",
  "ID": "f7cca173-b10e-464b-9a9c-b7d66c45a4af",
  "IsDeleted": true,
  "Name": "sample string 12",
  "PhoneNumber": "sample string 13",
  "PostalCode": "sample string 14",
  "ProviderId": "c0281d53-3ad7-4dbd-923d-8a412b996ca9",
  "RemoteId": "sample string 16",
  "SiteType": "sample string 17",
  "StateProvince": "sample string 18",
  "IsFavorite": true,
  "SubResourceUris": {
    "EULA": "sample string 1"
  },
  "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00",
  "_links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    }
  ]
}

[PUT] api/v1/Sites/Favorite?id={id}
Description

Adds the site as a favorite for the current user.

Parameter(s)
(FromUri) Guid id - The id of the site.
```
Sample: "6586a38d-376a-47f4-b436-5e0d0ce64dd2"
```
Returns

Response will not contain content.
[DELETE] api/v1/Sites/Favorite?id={id}
Description

Removes the site as a favorite for the current user.

Parameter(s)
(FromUri) Guid id - The site id.
```
Sample: "9bce06ee-0a01-48b4-964a-6b590ca41693"
```
Returns

Response will not contain content.

[GET] api/v1/Sites/Favorites?$skip={$skip}&$take={$take}

Description

Gets the favorite sites for the current logged in user.

Parameter(s)

(FromUri) Int32 $skip - The skip.

Sample: 1

(FromUri) Int32 $take - The take.

Sample: 1

Returns

SiteSearchResultListRepresentation

String Href
SiteSearchResultRepresentation Item
SiteSearchResultRepresentation Item
String LinkName
IList<Link> Links
String Rel

Element Type: SiteSearchResultRepresentation

String Address
String City
String Href
Guid ID
Boolean IsFavorite
Double Latitude
String LinkName
IList<Link> Links
Double Longitude
String PostalCode
Guid ProviderId
String ProviderLogoUrl
String ProviderName
String Rel
String RemoteId
String SiteName
String SiteType
String StateProvince

Sample

[
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "3377dce5-bd8c-435c-ab55-0ad7ed363a56",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "8281e7de-53ff-4fa4-9f39-959b5a18bdf5",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "2e7dd428-0d3a-4ed9-9ff7-01a2a7079bd8",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "3a06b9fa-e755-4911-bc41-ed459ef270e2",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "Address": "sample string 1",
    "City": "sample string 2",
    "ID": "baa48319-c301-4083-aae8-7527f2fec184",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "PostalCode": "sample string 6",
    "ProviderId": "c14344ea-2aca-479c-8fa2-e4b719d0cf66",
    "ProviderLogoUrl": "sample string 8",
    "ProviderName": "sample string 9",
    "RemoteId": "sample string 10",
    "SiteName": "sample string 11",
    "SiteType": "sample string 12",
    "StateProvince": "sample string 13",
    "IsFavorite": true,
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  }
]

[POST] api/v1/Sites/Sync

Description

Syncs a collection of site data with the system for a provider type. This action will "merge" the result set with what is in the system. Sites that are not found will be created; sites that are found but were not supplied in the "sites" collection will be deleted; and sites that are found in both collections will be updated.

Parameter(s)

The sites to sync.

Sample

{
  "Longitude": 1.1,
  "Latitude": 2.1,
  "Range": 3.1,
  "DistanceUnit": 0,
  "ProviderId": "569609f4-7aa4-4f01-8a40-54d9528fd4b1",
  "Sites": [
    {
      "GeoLocation": {
        "Latitude": 0.0,
        "Longitude": 0.0
      },
      "Options": [
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        },
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        },
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        }
      ],
      "ID": "784720e8-09bb-4d59-866e-46c6e1a2d748",
      "ProviderId": "2ec03955-b80f-4bd8-87eb-447147236daa",
      "Address": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "City": "sample string 7",
      "StateProvince": "sample string 8",
      "PostalCode": "sample string 9",
      "Country": "sample string 10",
      "PhoneNumber": "sample string 11",
      "CurrencySymbol": "sample string 12",
      "SiteType": "sample string 13",
      "Name": "sample string 14",
      "RemoteId": "sample string 15",
      "IsDeleted": true,
      "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00"
    },
    {
      "GeoLocation": {
        "Latitude": 0.0,
        "Longitude": 0.0
      },
      "Options": [
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        },
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        },
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        }
      ],
      "ID": "784720e8-09bb-4d59-866e-46c6e1a2d748",
      "ProviderId": "2ec03955-b80f-4bd8-87eb-447147236daa",
      "Address": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "City": "sample string 7",
      "StateProvince": "sample string 8",
      "PostalCode": "sample string 9",
      "Country": "sample string 10",
      "PhoneNumber": "sample string 11",
      "CurrencySymbol": "sample string 12",
      "SiteType": "sample string 13",
      "Name": "sample string 14",
      "RemoteId": "sample string 15",
      "IsDeleted": true,
      "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00"
    },
    {
      "GeoLocation": {
        "Latitude": 0.0,
        "Longitude": 0.0
      },
      "Options": [
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        },
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        },
        {
          "Name": "sample string 1",
          "DisplayName": "sample string 2",
          "ID": "7bf68752-a4f9-4db3-8a2b-7b5878735e1d"
        }
      ],
      "ID": "784720e8-09bb-4d59-866e-46c6e1a2d748",
      "ProviderId": "2ec03955-b80f-4bd8-87eb-447147236daa",
      "Address": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "City": "sample string 7",
      "StateProvince": "sample string 8",
      "PostalCode": "sample string 9",
      "Country": "sample string 10",
      "PhoneNumber": "sample string 11",
      "CurrencySymbol": "sample string 12",
      "SiteType": "sample string 13",
      "Name": "sample string 14",
      "RemoteId": "sample string 15",
      "IsDeleted": true,
      "ModifiedDate": "2024-11-22T17:36:28.6795279+00:00"
    }
  ]
}

Returns

Response will not contain content.

[GET] api/v1/Sites/UpdateSites?providerId={providerId}
Description

Updates the sites from the originated provider.

Parameter(s)
(FromUri) String
- Char Chars
- Int32 Length
Element Type: Char
providerId - No Documentation Found.
```
Sample: "sample string 1"
```
Returns

Response will not contain content.

[PUT] api/v1/Provider/

Description

Creates the specified provider.

Parameter(s)

The provider.

Sample

{
  "ID": "c6606803-1202-4042-a6b0-68282d749fe1",
  "Name": "sample string 2",
  "LogoUrl": "sample string 3",
  "ProviderTypeId": "8ace9025-93d5-402d-950d-1c4f4a2c3d68"
}

Returns

Response will not contain content.

[POST] api/v1/Provider/

Description

Updates the specified provider.

Parameter(s)

The provider.

Sample

{
  "ID": "e77a8bfb-11ba-4d00-b6d0-448208277053",
  "Name": "sample string 2",
  "LogoUrl": "sample string 3",
  "ProviderTypeId": "9c9c28a1-99e4-40cd-99e9-0222dc8b74ee"
}

Returns

Response will not contain content.

[GET] api/v1/Provider?id={id}

Description

Gets the provider matching the specified id.

Parameter(s)

(FromUri) Guid id - The id.

Sample: "4b480507-59ca-4727-ab78-23b2c4857d0c"

Returns

ProviderRepresentation

String Href
Guid ID
String LinkName
IList<Link> Links
String LogoUrl
String Name
Nullable<Guid> ProviderTypeId
String Rel

Sample

{
  "ID": "a826a29c-29ac-43e7-ab94-9b5e9c8b4e13",
  "LogoUrl": "sample string 2",
  "Name": "sample string 3",
  "ProviderTypeId": "45bfe8d5-3f70-468e-b0b5-be2d439d9ceb",
  "_links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "IsTemplated": true
    }
  ]
}

[DELETE] api/v1/Provider/Delete?id={id}
Description

Deletes the provider matching the specified id.

Parameter(s)
(FromUri) Guid id - The id.
```
Sample: "88b5e45f-3fe9-4a52-9310-884606159970"
```
Returns

Response will not contain content.

[GET] api/v1/Provider/Search?query={query}&$skip={$skip}&$take={$take}&providerTypeId={providerTypeId}

Description

Returns a list of all providers

Parameter(s)

(FromUri) String

Char Chars
Int32 Length

Element Type: Char

query - An open text value to search on.

Sample: "sample string 1"

(FromUri) Int32 $skip - The skip.

Sample: 1

(FromUri) Int32 $take - The take.

Sample: 1

(FromUri) String

Char Chars
Int32 Length

Element Type: Char

providerTypeId - The type of provider we are interested in

Sample: "sample string 1"

Returns

ProviderListRepresentation

String Href
ProviderRepresentation Item
ProviderRepresentation Item
String LinkName
IList<Link> Links
String Rel

Element Type: ProviderRepresentation

String Href
Guid ID
String LinkName
IList<Link> Links
String LogoUrl
String Name
Nullable<Guid> ProviderTypeId
String Rel

Sample

[
  {
    "ID": "dc2bfeca-337e-43a3-9db4-d491c6614af7",
    "LogoUrl": "sample string 2",
    "Name": "sample string 3",
    "ProviderTypeId": "da546b9f-0487-421c-89ea-d75bd678feba",
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "ID": "fb336732-ecc4-40d2-abc5-015150d57273",
    "LogoUrl": "sample string 2",
    "Name": "sample string 3",
    "ProviderTypeId": "a7738c95-cda0-4a96-b06f-6b526b0e3210",
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  },
  {
    "ID": "5c29e0ef-e225-49fa-b924-5c85196a7f90",
    "LogoUrl": "sample string 2",
    "Name": "sample string 3",
    "ProviderTypeId": "cc890438-7bbc-477a-88d4-9127c7c7d885",
    "_links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "IsTemplated": true
      }
    ]
  }
]

Versions

Security

Response Headers

v1

[PUT] api/v1/Job/

Description

Parameter(s)

Sample

Returns

[GET] api/v1/Job?id={id}

Description

Parameter(s)

Returns

Sample

[GET] api/v1/Job/History?$skip={$skip}&$take={$take}

Description

Parameter(s)

Returns

Sample

[DELETE] api/v1/Job/History

Description

Returns

[GET] api/v1/Job/Status?jobId={jobId}

Description

Parameter(s)

Returns

Sample

[POST] api/v1/Job/Status

Description

Parameter(s)

Sample

Returns

[GET] api/v1/Job/Options

Description

Returns

Sample

[GET] api/v1/EULA?providerId={providerId}

Description

Parameter(s)

Returns

[POST] api/v1/EULA/

Description

Parameter(s)

Sample

Returns

[PUT] api/v1/EULA/Agree?providerId={providerId}

Description

Parameter(s)

Returns

[GET] api/v1/Status/

Description

Returns

[GET] api/v1/ProviderTypes?$skip={$skip}&$take={$take}

Description

Parameter(s)

Returns

Sample

[PUT] api/v1/ProviderTypes/

Description

Parameter(s)

Sample

Returns

[GET] api/v1/Sites?id={id}&filterDeleted={filterDeleted}

Description

Parameter(s)

Returns

Sample

[PUT] api/v1/Sites/

Description

Parameter(s)

Sample

Returns

[POST] api/v1/Sites/

Description

Parameter(s)

Sample

Returns

[DELETE] api/v1/Sites/

Description

Parameter(s)