XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to fetch a full list of Passbook templates with skip and take parameters.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/passbook/templates?skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
    "Results":[
       {
           "Id":3,
           "UniqueName":"126c4ba2-e0bc-45f5-bdb3-67d0c17122c2",
           "Name":"87f953db-c821-4cd8-bfb0-275674c402ad",
           "LogoText":"fe99ea69-781d-4ae9-ab7d-f9acb0508702",
           "BarcodeType":1,
           "FormatVersion":"1",
           "BackgroundColor":"fcd98641-3218-4744-9f0b-56496b8b1972",
           "ForegroundColor":"f02708d2-e360-4968-9c1e-e814e0d8bfe4",
           "IconImage":{
               "Id":31,
               "FileName":"a87834b4-74af-4c30-90d5-1309f13c427b",
               "MimeType":"image/jpeg",
               "FileBody":null,
               "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/9bdf0a30-43ab-49f0-b744-029953b8288e"
           },
           "IconRetinaImage":{
               "Id":32,
               "FileName":"91fab825-341f-4c42-92fe-7acb33fbcdb4",
               "MimeType":"image/jpeg",
               "FileBody":null,
               "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/1bc8ce31-e975-4d2d-9772-7bac30b8e902"
           },
           "LogoImage":{
               "Id":33,
               "FileName":"da57a90d-7bc2-45fc-86a0-21c3c9ce9ea1",
               "MimeType":"image/jpeg",
               "FileBody":null,
               "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/3b7eacc5-7408-4551-8274-cbb76274e773"
           },
           "LogoRetinaImage":{
               "Id":34,
               "FileName":"f69f0ee4-273f-47d3-b0c9-5f30ff940664",
               "MimeType":"image/jpeg",
               "FileBody":null,
               "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/fc067e40-f80d-4d4c-9a57-715ddc0b1252"
           },
           "StripImage":{
               "Id":35,
               "FileName":"02d03869-c7ba-41cb-a003-1e68746eb8ab",
               "MimeType":"image/jpeg",
               "FileBody":null,
               "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/924f1cfb-7a7d-4ac4-bc8d-729401269387"
           },
           "StripRetinaImage":{
               "Id":36,
               "FileName":"d33220ed-1080-44b2-af62-173a5ddd0dc2",
               "MimeType":"image/jpeg",
               "FileBody":null,
               "PublicUrl":"http://127.0.0.1:10000/tenantassetspubliccontainer/5fe758dd-ef64-4495-87f5-e61ac0c05a4e"
           },
           "Description":"0cc4e01c-25ba-4f10-b20a-4dd221fb3569",
           "LabelColor":"57e51343-c136-4e9e-9597-4e3cf9d9b958",
           "SupressStripShine":true,
           "PassbookAssociatedStoreIdentifier":1,
           "BarcodeMessageFormat":"3a7e785f-e4ec-4117-ac7e-3032081f06b5",
           "BackFieldLabel1":"37c1c36c-05fd-48a9-96c6-46b887664a8a",
           "BackFieldLabel2":"924f7449-37ae-4f23-b1ac-628291f29f47",
           "BackFieldLabel3":"e7ad9979-3196-4de6-88e2-8a5e932f622c",
           "BackFieldPlaceholder1":"9faa22e9-55a7-4c7f-a571-3750408bd1e9",
           "BackFieldPlaceholder2":"8673e46e-0af4-4881-8edb-1a787aaf5666",
           "BackFieldPlaceholder3":"366197cf-3c1b-4ad4-8e00-1372f3bdcb83",
           "Currency":{
               "Id":6,
               "Description":"test",
               "CurrencySymbol":"test"
           }
       }
    ],
    "TotalCount":1
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of passbooks in the filtered collection without paging. Number
Results[0..N].Id The unique ID of the Passbook template. Number
Results[0..N].UniqueName The unique name of the Passbook template. String
Results[0..N].Name The name of the Passbook template. String
Results[0..N].LogoText Passbook Logo text. String
Results[0..N].BarcodeType Passbook barcode type (see Passbook Barcode Type APIs for possible values). Number
Results[0..N].FormatVersion Passbook format version. String
Results[0..N].BackgroundColor Passbook background color (in RGB format). String
Results[0..N].ForegroundColor Passbook foreground color (in RGB format). String
Results[0..N].Description Passbook description. String
Results[0..N].PassbookBodyFormat Body content of the passbook. String
Results[0..N].SupressStripShine Passbook “suppressstripshine” Boolean property. Boolean
Results[0..N].PassbookAssociatedStoreIdentifier Passbook associated store identifier. Number
Results[0..N].BarcodeMessageFormat Passbook barcode message format. String
Results[0..N].BackFieldLabel1 Passbook back field label. String
Results[0..N].BackFieldLabel2 Passbook back field label. String
Results[0..N].BackFieldLabel3 Passbook back field label. String
Results[0..N].BackFieldPlaceholder1 Passbook back field place holder. String
Results[0..N].BackFieldPlaceholder2 Passbook back field place holder. String
Results[0..N].BackFieldPlaceholder3 Passbook back field place holder. String
Results[0..N].Currency.Id This is the unique ID for the currency. Number
Results[0..N].Currency.Description Description of the currency. String
Results[0..N].Currency.CurrencySymbol Currency symbol of the currency String
Results[0..N].StripRetinaImage.PublicUrl Public URI of the icon image asset. String
Results[0..N].StripRetinaImage.Id Unique ID of the icon image asset. Number
Results[0..N].StripRetinaImage.FileName File name of the icon image asset. String
Results[0..N].StripRetinaImage.MimeType Mime type of the icon image asset. String
Results[0..N].StripRetinaImage.FileBody File body of the icon image asset. Array
Results[0..N].StripImage.PublicUrl Public URI of the icon image asset. String
Results[0..N].StripImage.Id Unique ID of the icon image asset. Number
Results[0..N].StripImage.FileName File name of the icon image asset. String
Results[0..N].StripImage.MimeType Mime type of the icon image asset. String
Results[0..N].StripImage.FileBody File body of the icon image asset. Array
Results[0..N].LogoRetinaImage.PublicUrl Public URI of the icon image asset. String
Results[0..N].LogoRetinaImage.Id Unique ID of the icon image asset. Number
Results[0..N].LogoRetinaImage.FileName File name of the icon image asset. String
Results[0..N].LogoRetinaImage.MimeType Mime type of the icon image asset. String
Results[0..N].LogoRetinaImage.FileBody File body of the icon image asset. Array
Results[0..N].LogoImage.PublicUrl Public URI of the icon image asset. String
Results[0..N].LogoImage.Id Unique ID of the icon image asset. Number
Results[0..N].LogoImage.FileName File name of the icon image asset. String
Results[0..N].LogoImage.MimeType Mime type of the icon image asset. String
Results[0..N].LogoImage.FileBody File body of the icon image asset. Array
Results[0..N].IconRetinaImage.PublicUrl Public URI of the icon image asset. String
Results[0..N].IconRetinaImage.Id Unique ID of the icon image asset. Number
Results[0..N].IconRetinaImage.FileName File name of the icon image asset. String
Results[0..N].IconRetinaImage.MimeType Mime type of the icon image asset. String
Results[0..N].IconRetinaImage.FileBody File body of the icon image asset. Array
Results[0..N].IconImage.PublicUrl Public URI of the icon image asset. String
Results[0..N].IconImage.Id Unique ID of the icon image asset. Number
Results[0..N].IconImage.FileName File name of the icon image asset. String
Results[0..N].IconImage.MimeType Mime type of the icon image asset. String
Results[0..N].IconImage.FileBody File body of the icon image asset. Array

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations.