RightsZone

This rest API follows the same model as all APIs for RightsZone. Please Familiarize yourself with these articles to start:

• API Overview
• API Initial Authentication
• Calling the RightsZone API

What this API does

This API inserts or updates Project (Work) records only. 

End Point

/dataload/project

Input

The input is an array of projectDtos records where either the projectId or the extSysProjectId fields are sent. They populate the RZone__Project__c object in RightsZone

JSON Structure

The JSON wrapper is projectDetailList and you can send one or many records

{ 

"projectDetailList":[

    {projectDto1},

    {projectDto1},

    ...

    ]

}   

Data can be: 

• Boolean fields are ‘true’ or ‘false’
• Ids are Salesforce Ids
• Ext Sys Ids are an Id in your system integrating to RightsZone, e.g. your Title Management system.
• String is any text

Required Parameters

At least one of these is parameters is required.

• projectId: the Salesforce record ID
• extSysProjectId: the unique Id of the project in your own system (generally Title Management System) - can be the primary format ISBN for example or a system uniqueId if you have one. But something that uniquely identifies this Project (title) over time i.e. is persistent.
• In addition: productShortTitle: Short Title, division: Publisher Division, authorStringInverted Author String Inverted, authorString Author String, legalEntity Legal Entity and productStatus Project Status ARE MANDATORY.  mainFormat Populate Primary Format should also be set to TRUE.

Responses  

• All records you send are returned in the same exact order

• Each row is associated with a success or a failure

• ObjectList will contain all the records inserted for the corresponding row

• In this case, there will only be one record as it is the Project only API so only a Project record is created

• ProjectId is the corresponding Salesforce Id of the record you inserted/updated.

{

            "status":"Success",

            "row":"0",

            "objectList":[{

                        "source":"Project Upsert”,

                        "sfId":"a0K0O00000YGufuUAD",

                        "externalId":"Project1TestInsert"

            }],

            "error":"",

            "projectId":"a0K0O00000YGufuUAD",

            "projectExternalId":"Project1TestInsert"

}

General Error

There is a problem with the API usage/format, the JSON is invalid or the data type of a field is incorrect:

Request example:

{

"TEST":[ { 

}]

}

Response:

{

            [{

                        "status":"failure",

                        "row":"0",

                        "objectList":null,

                        "error":"Your attempt to use the service is not valid”

            }]

}

Data Errors

The API usage is correct however something is wrong with the data. This happens when the data itself is not properly set to be inserted/updated against the project record. For example, if the DivisionId is incorrect then RZ returns this error (Note: sometimes the error doesn’t mention the name of the field failing due to SF limitations).  

Response:

{ 

   "responseList": [

        {

             "status": "Success",

            "row": "0",

             "objectList": [

                {

                    "source": "Project Upsert",

                     "sfId": "a0K0O00000YGufuUAD",

                     "externalId": "Project1TestInsert"

                }

            ],

            "error": "",

             "projectId": "a0K0O00000YGufuUAD",

             "projectExternalId": "Project1TestInsert"

        }

    ]

}

Common Issues

See Common API Issues for details of common errors and queries

ProjectDto definition

Request Example:

 {

 "projectDetailList":[{   

 "translationRights":true,

"themaSubjectCodes":"Anthropology",

"territory":null,

"targetMarket":null,

"subtitle":null,

"rightsReverted":true,

"publicationDate":null,

"projectId":null,

"productURL":"URLP",

"productStatus":"Forthcoming",

"productShortTitle":"Test Book",

"previousEditionTitle":null,

"payOnGross":null,

"payEarly":null,

"mainFormat":null,

"longTitle":"LONG",

"levelAudience":"College/higher education",

"legalEntity":"Default",

"languageTerms":null,

"jacketImageURL":null,

"isbn13":"randomISBN",

"internalSubjectCodes":"Anthropology",

"imprint":"CHC Classics",

"illustrationsSummary":null,

"extSysProjectId":"Project1TestInsert",

"extent":null,

"englishLanguageReprintRights":true,

"editionStatement":null,

"editionNumber":1,

"editedProject":true,

"division":null,

"copyrightYear":2010,

"bicSubjectString":null,

"authorStringInverted":null,

"authorString":"EEEE",

"approvalOrNotificationRequired":"Approval Required",

"bisacSubjectString": "", 

"genre": "Historic", 

"keywords": "", 

"originalPublisher": "", 

"projectIssn": "", 

"projectOrigin": "", 

"projectSeries": "", 

"publisherEditor": "", 

"volumeNumber": 4, 

"proprietorName": "",

"noRightsEB": true,

"noRightsHB": false,

"noRightsPB": true,

"noRightsAllFormats": false,

"subjectGroup": "Subject Example"

“pmgCode” : "some pmg code",

“titleCode”: "Title 101",

“audienceText”: "some text about the audience",

 “openAccessStatus” : “Open Access”,

“openAccessfundingBody” “some academic institution”,

“openAccesslicenseType” : “CC BY-NC-ND”

"editorialAssistant": "Assistant Name"

"onSaleDate": "string"

}]

}