Business cards

GetBusinessCardCall

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.
Results The maximum number of business cards in a single response; must be one of 50, 100, or 200.
PageNo The page number with the results. The first page is 1, and the last page will be calculated based on the response.
ModifiedSince Optional. Filters business cards by date. Time should be expressed compliant to ISO 8601.

Request

<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>FSL023424ASDFWADIPQLD459DKLD7446</ApiUserToken>
        <SbxUserToken>ksdfjsdkfjfskjk2342342342kj243kj</SbxUserToken>
    </RequesterCredentials>
    <GetBusinessCardCall>
        <BusinessCardFilter>
            <Results>50</Results>
            <PageNo>1</PageNo>
            <ModifiedSince>2001-01-01T00:00:10</ModifiedSince> <
        </BusinessCardFilter>
    </GetBusinessCardCall>
</Request>

Response

<GetBusinessCardCallResponse>
    <BusinessCards count="74">
        <BusinessCard id="331378049" firstName="Richard" lastName="Davies" createDate="2/5/2009" address="" address2="" city="RTP" state="NC" zip="27713" country="USA" email="Richard@Samplecompany.com" website="" company="Plaza Bridge" position="Managing Partner" workPhone="919 555-0557" cellPhone="" fax="" frontImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=331378049&code=eb43ab329ef9902ps27bf2c1e4a93c51" backImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=331378049&back=y&code=eb43ab309ol99fc9727bf2c1e4a93c51" note="met at downtown Durham networking event"/>
        <BusinessCard id="339098065" firstName="Joseph" lastName="Doe" createDate="2/5/2009" address="" address2="" city="Research Triangle Park" state="NC" zip="27709" country="USA" email="jdoe@samplecompany.org" website="" company="Doe Financial" position="President" workPhone="919.555.0019 " cellPhone="" fax="919-555-0156" frontImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=339098065&code=eb43ab329ef30dk9727bf2c1e4a93c51" backImgUrl="" note=""/>
        <BusinessCard id="331384066" firstName="Adam" lastName="Mingos" createDate="2/5/2009" address="" address2="" city="CHAPEL HILL" state="NC" zip="27516" country="USA" email="adam@samplecompany.com" website="" company="Mingos Agency" position="" workPhone="919-555-8031" cellPhone="" fax="866-555-0361" frontImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=331384066&code=eb43ab329ef99fc97238dsc1e4a93c51" backImgUrl="" note="son's name is john"/>
        <BusinessCard id="239492324" firstName="Jane" lastName="Doe" createDate="12/1/2008" address="" address2="" city="Apex" state="NC" zip="" country="USA" email="jane@samplecompany.com" website="www.samplecompany.com" company="Sample Company" position="CEO" workPhone="9195550906" cellPhone="" fax="" frontImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=239492324&code=dfdc3494c2361c38dk13b1efb989665f" backImgUrl="" note=""/>
    </BusinessCards>
</GetBusinessCardCallResponse>

The count attribute of the BusinessCards element (second line in the response) is the total number of bcards, not the number of bcards on a page.

Response when account has no business cards

<GetBusinessCardCallResponse>
    <BusinessCards count="0" />
</GetBusinessCardCallResponse>

GetBusinessCardInfoCall

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.
BusinessCardId The ID of the business card.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
	<RequesterCredentials>
		<ApiUserToken>FSL023424ASDFWADIPQLD459DKLD7446</ApiUserToken>
		<SbxUserToken>ksdfjsdkfjfskjk2342342342kj243kj</SbxUserToken>
	</RequesterCredentials>
	<GetBusinessCardInfoCall>
		<BusinessCardFilter>
		<BusinessCardId>331378049</BusinessCardId>
		</BusinessCardFilter>
	</GetBusinessCardInfoCall>
</Request>

Response

<GetBusinessCardInfoCallResponse>
    <BusinessCard id="331378049" firstName="Richard" lastName="Davies" createDate="2/5/2009" address="" address2="" city="RTP" state="NC" zip="27713" country="USA" email="Richard@Samplecompany.com" website="" company="Plaza Bridge" position="Managing Partner" workPhone="919 555-0557" cellPhone="" fax="" frontImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=331378049&code=eb43ab329ef9902ps27bf2c1e4a93c51" backImgUrl="https://www.shoeboxed.com/business-card.jpeg?bcid=331378049&back=y&code=eb43ab309ol99fc9727bf2c1e4a93c51" note="met at downtown Durham networking event"/>
</GetBusinessCardInfoCallResponse>

GetBusinessCardStatusCall deprecated; see GetDocumentStatusCall

EstimatePdfBusinessCardReportCall

Used to estimate the number of pages this PDF export of business cards will be.

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <EstimatePdfBusinessCardReportCall/>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<EstimatePdfBusinessCardReportCallResponse>
    <NumberOfBusinessCards>140</NumberOfBusinessCards>
    <NumberOfPages>70</NumberOfPages>
</EstimatePdfBusinessCardReportCallResponse>

GeneratePdfBusinessCardReportCall

Generates the actual PDF export of business cards. Returns the URL of the generated PDF. NB: the URL can only be accessed once.

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <GeneratePdfBusinessCardReportCall/>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GeneratePdfBusinessCardReportCallResponse>
    <URL>https://app.shoeboxed.com/api/export/pdf-business-cards/198375212/65708a18ea05969e72f69dc289077fff</URL>
</GeneratePdfBusinessCardReportCallResponse>

GetBusinessCardExportsCall

Used to find which export options this user has enabled.

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <GetBusinessCardExportsCall/>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GetBusinessCardExportsCallResponse>
    <Exports>
        <Export>
            <Id>DEFAULT</Id>
            <Name>Default</Name>
            <Enabled>true</Enabled>    <!-- Always enabled -->
        </Export>
        <Export>
            <Id>EVERNOTE</Id>
            <Name>Evernote</Name>
            <Enabled>true</Enabled>    <!-- Enabled if user has set Evernote address -->
        </Export>
        <Export>
            <Id>GOOGLE_MAIL</Id>
            <Name>Google Mail</Name>
            <Enabled>true</Enabled>    <!-- Enabled if user has authorized with Google -->
        </Export>
        <Export>
            <Id>YAHOO_MAIL</Id>
            <Name>Yahoo Mail</Name>
            <Enabled>false</Enabled>   <!-- Enabled if user has authorized with Yahoo -->
        </Export>
    </Exports>
</GetBusinessCardExportsCallResponse>