{"info":{"_postman_id":"5913c086-852e-467a-be00-26f395542885","name":"SPARGO LITE API","description":"

Introduction

This is SPARGO's API Lite which can be used to retreive basic information from an event's database. There are four end points available. Availability of an end point is event and vendor specific. So, not all vendors/clients may have access to all end points. If you believe you need access to certain information and do not have access to please reach out to DiDept@spargoinc.com

{{BASEURL}}/api/spargo/lite/reg
{{password}}/api/spargo/lite/person
{{showcode}}/api/spargo/lite/demo

Authentication

This API uses Basic Authentication to verify identity and permissions. This consists of sending as Base64 Encoded USERNAME and PASSWORD in the header.

We also require a ShowCode to passed in the header to identify which show you are pulling data from.

Please contact your account manager or DiDept@spargoinc.com if you have not already received these credentials.

Postman Documentation Info

You may see a few values in this documentation surrounded by double curly brackets {{}}. This is used to mask the actual values to be passed for security. If you import this collection into Postman, you can use the Environmental Variables to set values for these fields.

Example fields are

{{username}}
{{password}}
{{showcode}}

Beta & Production Endpoints

This documentation has the SPARGO Beta URL used in the example. When you are ready to go into Production, replace https://showbeta.jspargo.com with https://showws.jspargo.com.

The production API must be turned on before you can use it

Help

For help with the API please contact didept@spargoinc.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"958300","collectionId":"5913c086-852e-467a-be00-26f395542885","publishedId":"T1Ds8apw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-27T19:49:02.000Z"},"item":[{"name":"Get Registration Changes","id":"6013be3a-7c03-4d9f-b060-388e49371d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/reg?FromDate={{FromDate}}&ToDate={{ToDate}}","description":"

This method will accept a From Date and a To Date and will return the Registration Id's of all new registrations and registrations that are updated between the two dates. Both are optional parameters, if the values are not sent in, the API will return all registration Id's that are qualified.

{{FromDate}} - Date/Time
{{ToDate}} - Date/Time

The response contains a response object that contains success, errorMessage, BatchNumber and an array of Registration Numbers. The attribute Success will return a true if the call is successful or false if the call is unsuccessful. The errorMessage will either be null if the call is successful or an error message indicating why the call failed. BatchNumber is a unique number returned with this call when a FromDate and a ToDate is sent in. The batch number can be saved and sent along with other calls to get Person/Demo or Event information of all attendees returned.

\n","urlObject":{"protocol":"https","path":["JSADataExportServiceAPI","api","spargo","lite","reg"],"host":["showbeta","jspargo","com"],"query":[{"key":"FromDate","value":"{{FromDate}}"},{"key":"ToDate","value":"{{ToDate}}"}],"variable":[]}},"response":[{"id":"387a1949-865a-422f-b6ad-e615cbb6937e","name":"Get Registration Changes","originalRequest":{"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":{"raw":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/reg?FromDate={{FromDate}}&ToDate={{ToDate}}","protocol":"https","host":["showbeta","jspargo","com"],"path":["JSADataExportServiceAPI","api","spargo","lite","reg"],"query":[{"key":"FromDate","value":"{{FromDate}}"},{"key":"ToDate","value":"{{ToDate}}"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"success\": true,\n \"errorMessage\": null\n },\n \"BatchNumber\": \"999999\",\n \"RegistrationNumbers\": [\n \"111111\",\n \"222222\",\n \"333333\",\n \"444444\",\n \"555555\",\n \"666666\",\n \"777777\"\n ]\n}"}],"_postman_id":"6013be3a-7c03-4d9f-b060-388e49371d93"},{"name":"Get Person Data","id":"f8560d3c-3d49-44b5-b0dc-7298ccb666e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/person?BatchNumber={{BatchNumber}}&RegId={{RegistrationId}}","description":"

This method will accept a Batch Number or RegId and will either return the Personal Information for all attendees returned in the Registration Changes call or a single attendee.

Unless you are looking to grab the information for a single attendee it is always recommended to send in the BatchNumber with this call to get the personal information for an entire batch.

{{BatchNumber}} - Batch Number returned from Registration Changes call

{{RegId}} - Registration Id - an unique identifier in SPARGO's database to GET single attendee's details.

The response contains a response object that contains success, errorMessage, and an array of attendees with Personal informaton.

\n","urlObject":{"protocol":"https","path":["JSADataExportServiceAPI","api","spargo","lite","person"],"host":["showbeta","jspargo","com"],"query":[{"key":"BatchNumber","value":"{{BatchNumber}}"},{"key":"RegId","value":"{{RegistrationId}}"}],"variable":[]}},"response":[{"id":"a620745b-bd16-4677-b626-bf49eb6e6280","name":"Get Person Data","originalRequest":{"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":{"raw":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/reg?BatchNumber={{BatchNumber}}&RegId={{RegistrationId}}","protocol":"https","host":["showbeta","jspargo","com"],"path":["JSADataExportServiceAPI","api","spargo","lite","reg"],"query":[{"key":"BatchNumber","value":"{{BatchNumber}}"},{"key":"RegId","value":"{{RegistrationId}}"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"success\": true,\n \"errorMessage\": null\n },\n \"PersonInformation\": [\n {\n \n },\n {\n \n }\n ]\n}"}],"_postman_id":"f8560d3c-3d49-44b5-b0dc-7298ccb666e6"},{"name":"Get Demo Data","id":"51ab2b64-4cd0-46d7-9253-edb1ed3da833","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/demo?BatchNumber={{BatchNumber}}&RegId={{RegId}}","description":"

This method will accept a Batch Number or RegId and will either return the Demographic Information for all attendees returned in the Registration Changes call or a single attendee.

Unless you are looking to grab the information for a single attendee it is always recommended to send in the BatchNumber with this call to get the demographic information for an entire batch.

{{BatchNumber}} - Batch Number returned from Registration Changes call

{{RegId}} - Registration Id - an unique identifier in SPARGO's database to GET single attendee's demographic details.

The response contains a response object that contains success, errorMessage, and an array of attendees with Demographic informaton.

\n","urlObject":{"protocol":"https","path":["JSADataExportServiceAPI","api","spargo","lite","demo"],"host":["showbeta","jspargo","com"],"query":[{"key":"BatchNumber","value":"{{BatchNumber}}"},{"key":"RegId","value":"{{RegId}}"}],"variable":[]}},"response":[{"id":"e55f7b1e-5abe-4d71-b9e2-5594c319c34e","name":"Get Demo Data","originalRequest":{"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":{"raw":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/demo?BatchNumber={{BatchNumber}}&RegId={{RegId}}","protocol":"https","host":["showbeta","jspargo","com"],"path":["JSADataExportServiceAPI","api","spargo","lite","demo"],"query":[{"key":"BatchNumber","value":"{{BatchNumber}}"},{"key":"RegId","value":"{{RegId}}"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"response\": {\r\n \"success\": true,\r\n \"errorMessage\": null\r\n },\r\n \"DemographicInformation\": [\r\n {\r\n \r\n },\r\n {\r\n \r\n }\r\n ]\r\n}"}],"_postman_id":"51ab2b64-4cd0-46d7-9253-edb1ed3da833"},{"name":"Get Event Data","id":"e4dbffdd-7ae2-47a2-8acb-b44a1c63177f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/event?BatchNumber={{BatchNumber}}&RegId={{RegId}}","description":"

This method will accept a Batch Number or RegId and will either return the Personal Information for all attendees returned in the Registration Changes call or a single attendee.

Unless you are looking to grab the information for a single attendee it is always recommended to send in the BatchNumber with this call to get the event information for an entire batch.

{{BatchNumber}} - Batch Number returned from Registration Changes call

{{RegId}} - Registration Id - an unique identifier in SPARGO's database to GET single attendee's details.

The response contains a response object that contains success, errorMessage, and an array of attendees with Event informaton.

\n","urlObject":{"protocol":"https","path":["JSADataExportServiceAPI","api","spargo","lite","event"],"host":["showbeta","jspargo","com"],"query":[{"key":"BatchNumber","value":"{{BatchNumber}}"},{"key":"RegId","value":"{{RegId}}"}],"variable":[]}},"response":[{"id":"ddfce26d-4858-4e49-8fc7-4b5d5aa4e954","name":"Get Event Data","originalRequest":{"method":"GET","header":[{"key":"showcode","value":"{{showcode}}","type":"text"}],"url":{"raw":"https://showbeta.jspargo.com/JSADataExportServiceAPI/api/spargo/lite/event?BatchNumber={{BatchNumber}}&RegId={{RegId}}","protocol":"https","host":["showbeta","jspargo","com"],"path":["JSADataExportServiceAPI","api","spargo","lite","event"],"query":[{"key":"BatchNumber","value":"{{BatchNumber}}"},{"key":"RegId","value":"{{RegId}}"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"success\": true,\n \"errorMessage\": null\n },\n \"EventInformation\": [\n {\n \n },\n {\n \n }\n ]\n}"}],"_postman_id":"e4dbffdd-7ae2-47a2-8acb-b44a1c63177f"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]}}}