POST api/NorthStarSync/Sync/SyncScheduleNextSync_001
Request Information
URI Parameters
None.
Body Parameters
SyncScheduleNextSync_001_Params| Name | Description | Type | Additional information |
|---|---|---|---|
| SyncScheduleDateTime | date |
Required |
|
| SyncScheduleProcessMemberImages | boolean |
Required |
|
| SyncScheduleProcessESP | boolean |
Required |
|
| SyncScheduleProcessMbrPWFile | boolean |
Required |
|
| SyncScheduleSyncActiveMembersToBuiltIO | boolean |
Required |
|
| SyncScheduleSyncInActiveMembersToBuiltIO | boolean |
Required |
|
| SyncScheduleProcessMemberData | boolean |
Required |
|
| SyncScheduleAsOfDateOverride | date |
None. |
|
| SyncScheduleUpdateAllData | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"SyncScheduleDateTime": "2026-11-02T16:42:10.3594982-05:00",
"SyncScheduleProcessMemberImages": true,
"SyncScheduleProcessESP": true,
"SyncScheduleProcessMbrPWFile": true,
"SyncScheduleSyncActiveMembersToBuiltIO": true,
"SyncScheduleSyncInActiveMembersToBuiltIO": true,
"SyncScheduleProcessMemberData": true,
"SyncScheduleAsOfDateOverride": "2026-11-02T16:42:10.3594982-05:00",
"SyncScheduleUpdateAllData": true
}
application/xml, text/xml
Sample:
<SyncModel.SyncScheduleNextSync_001_Params xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NorthStarSyncWebAPI.Models.NorthStarSync"> <SyncScheduleAsOfDateOverride>2026-11-02T16:42:10.3594982-05:00</SyncScheduleAsOfDateOverride> <SyncScheduleDateTime>2026-11-02T16:42:10.3594982-05:00</SyncScheduleDateTime> <SyncScheduleProcessESP>true</SyncScheduleProcessESP> <SyncScheduleProcessMbrPWFile>true</SyncScheduleProcessMbrPWFile> <SyncScheduleProcessMemberData>true</SyncScheduleProcessMemberData> <SyncScheduleProcessMemberImages>true</SyncScheduleProcessMemberImages> <SyncScheduleSyncActiveMembersToBuiltIO>true</SyncScheduleSyncActiveMembersToBuiltIO> <SyncScheduleSyncInActiveMembersToBuiltIO>true</SyncScheduleSyncInActiveMembersToBuiltIO> <SyncScheduleUpdateAllData>true</SyncScheduleUpdateAllData> </SyncModel.SyncScheduleNextSync_001_Params>
application/x-www-form-urlencoded
Sample:
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
SyncScheduleNextSync_001_Record| Name | Description | Type | Additional information |
|---|---|---|---|
| SyncScheduleB64Id | string |
None. |
|
| SyncScheduleDateTime | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"SyncScheduleB64Id": "sample string 1",
"SyncScheduleDateTime": "2026-11-02T16:42:10.3705762-05:00"
}
application/xml, text/xml
Sample:
<SyncModel.SyncScheduleNextSync_001_Record xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NorthStarSyncWebAPI.Models.NorthStarSync"> <SyncScheduleB64Id>sample string 1</SyncScheduleB64Id> <SyncScheduleDateTime>2026-11-02T16:42:10.3705762-05:00</SyncScheduleDateTime> </SyncModel.SyncScheduleNextSync_001_Record>
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.